Showing posts with label creating resources. Show all posts
Showing posts with label creating resources. Show all posts

08 June 2011

Requirements and Specifications of Resources Hosted Here

The criteria for hosting resources on this site are:
  • It can be legally redistributed;
  • The content is what it purports to be;
  • It conforms to the specification criteria of one of the following:
  1. e-Sword Resource Format Specification 1;
  2. e-Sword Resource Format Specification 2;
  3. Pocket e-Sword 3.x;
The content of the resource is irrelevant to whether or not the resource is hosted here.

What that means:

It can be legally redistributed.
This means that if a resource is downloaded from this site, the user can distribute elsewhere, without running afoul of copyright law. The only qualifier here is that the distribution is gratis.

The content is what it purports to be
This means that if the resource claims to be Codex Aleppo, the content of the resource is a faithful represenation of Codex Aleppo. Any additions and alterations should be clearly delineated.  This also means that a resource is not rejected, purely because it uses an inappropriate resource format. 

It conforms to the specification criteria
This means that it displays content correctly, for the version of e-Sword, or Pocket e-Sword that it was created for.
e-Sword Resource Format Specification 0
I coined this term to refer to the criteria for resources for e-Sword 7.x. These resources usually do not display correctly e-Sword 8.x.
e-Sword Resource Format Specification 1
These are the specifications for e-Sword 8.0.6.

e-Sword Resource Format Specification 2

These are the specifications for e-Sword 9.0.1.

Due to some minor changes in the specifications, I dubbed the criteria for e-Sword 9.7.2 to be e-Sword Resource Format Specification 2a.  But that is purely a personal term.  Thus far, no user created resources contain the markup that triggered those minor changes.

Pocket e-Sword 3.x
These are the specifications for Pocket e-Sword.

The Last Sentence:
The content of the resource is irrelvent to whether or not the resource is hosted here.

e-Sword-users.org does not discriminate on the basis of content. Regardless of how appropriate, or inappropriate the content of the resource is, for the type of resource that it is created within, that content will not eliminate the resource from being available here, if it meets the other criteria.

This means that there are resources that do not contain the expected paraphrase of "In the Begining God Created the Heaven and the Earth" for Genesis 1:1, or "These are the ancestors of Jesus the Christ, The Son of Abraham, the Son of Isaac, the Son of David", for Matthew 1:1.

This also means that resources that are X rated could be distributed here.  (Tim May's Translation of the Bible is one potential X rated resource that is text only. A graphic/map resource of Samson and Delialiah, or David and Bathsheeba might easilly be X rated.)

This also means that we do not reject resources, because we disagree with their theological orientation.

Things that are not mandatory, but probably should be

These are not official requirements, but make resource management much easier:
  • Include The Copyright Table;
  • Include The Metadata Table;
The Copyright Table
This table is where complete bibliographic data for the resource should be placed.
  • Where the first hardcopy edition was published.
  • Which hardcopy edition was used as the source text for the resource;
  • Who gave permission for the resource to be distributed;
In short, it should answer all potential questions about the copyright status of the resource, and where to go to obtain permission to utilize the resource elsewhere.


The MetaData Table
This table should contain the complete Dublin Core Meta Data for the resource.  Furthermore, this is where the theological orientation of the resource should be placed.

Creating These Resources


BeST 2.X creates resources that contain the Copyright Table and MetaData Table. It also creates resources that conform to:
  1. e-Sword Resource Format Specification 1;
  2. e-Sword Resource Format Specification 2;
  3. Pocket e-Sword 3.x;

The major issue for resource creators, is ensuring that the content of the resource is a faithful representation of what it purports to be.


###

This was originally posted to my blog at e-sword-users.org on 25 January 2011

23 July 2009

e-Sword Resource Creation Tools

How to create a resource depends upon:


  • What type of resource it is;

  • Which program it is for ( e Sword 9.x, e Sword 8.x, Pocket e Sword);

  • Which operating system you are using. (Windows, Linux, something else);


Going in reverse order:


Other Operating System (BSD, Mac OS X, OpenSolaris, etc)


  • Pocket e Sword


No known tools;


  • e Sword 8.x


Importing into e Sword 8.x

  • No known tools;


Editing existing e Sword 8.x Resources:

  • No known tools;

  • Text2DAO under WINE, or similar Windows Emulation Program might work;


  • e Sword 9.x


Importing into e Sword 9.x:

  • No known tools;


Editing existing e Sword 9.x Resources:

  • Firefox with SQLite Manager;

  • SQLite Dabase Browser;

  • Both of these programs are generic database editors. They require e Sword 9.x database templates if one wishes to use them to create new e Sword resources.


Linux


  • Pocket e Sword


No known tools;


  • e Sword 8.x


Importing into e Sword 8.x;

  • Text2DAO under WINE, or similar Windows Emulation Program might work;


Editing existing e Sword 8.x Resources:

  • No known tools;

  • Text2DAO under WINE, or similar Windows Emulation Program;


  • e Sword 9.x


Importing into e Sword 9.x:

  • No known tools;


Editing existing e Sword 9.x Resources:

  • Firefox with SQLite Manager;

  • SQLite Dabase Browser;

  • Both of these programs are generic database editors. They require e Sword 9.x database templates if one wishes to use them to create new e Sword resources.


Windows


  • Pocket e Sword


BeST 2.1.0.1 Premium Edition is the only currently available tool that creates resources for Pocket e Sword.


  • e Sword 9.x


Importing into e Sword 9.x:

  • BeST 2.1.0.1 Standard Edition;

  • BeST 2.1.0.1 Premium Edition;

  • These are the only currently available tools

designed specifically for creating e Sword 9.x resources;


Editing existing e Sword 9.x Resources:

  • Firefox with SQLite Manager;

  • SQLite Dabase Browser;

  • Both of these programs are generic database editors. They require e Sword 9.x database templates if one wishes to use them to create new e Sword resources.


  • e Sword 8.x


Importing into e Sword 8.x:

  • BeST 2.1.0.1 Standard Edition;

  • BeST 2.1.0.1 Premium Edition;

  • These are the only currently available tools designed specifically for creating e Sword 8.x resources;


Editing existing e Sword 8.x Resources:

  • Text2DAO;

  • This tool can generate its own e Sword 7.x database template for some resource types. As a general rule using e Sword 8.x database templates is recommended;

  • TheWordPad Editor 2.0;

  • This tool requires e Sword 8.x database templates, if one wishes to use it to create new e Sword resources;

  • These two tools are the only currently available tools specifically designed for e Sword resource editing, that can edit e Sword 8.x resources;

  • Microsoft Access 97;

  • Microsoft Access 2000;

  • These two versions of Microsoft Access require e Sword 8.x database templates, if one wishes to use them to create new e Sword resources;


  • e Sword 7.x


Importing into e Sword:

  • Text2Dao;

  • This are the only currently available tools designed specifically for creating e Sword 7.x resources;


Editing existing e Sword 7.x Resources:

  • Text2DAO;

  • This tool can generate its own e Sword 7.x database template for some resource types. As a general rule using e Sword 7.x database templates is recommended;

  • TheWordPad Editor 2.0;

  • This tool requires e Sword 7.x database templates, if one wishes to use it to create new e Sword resources;

  • Module Utility for e Sword 1.0.6.2;

  • Module Editor 2.0.2;

  • These two tools generate their own e Sword templates;

  • These four tools are the only currently available tools specifically designed for e Sword resource editing, that can edit e Sword 7.x resources;

  • Microsoft Access 97;

  • Microsoft Access 2000;

  • These tools require e Sword database templates, if one wishes to use them to create new e Sword resources;


Templates


  • Templates for e Sword 8.x have not been publicly distributed;

  • Templates for e Sword 9.x have not been publicly distributed;

  • Templates for e Sword 7.x were publicly distributed;

  • Templates for Pocket e Sword have not been publicly distributed;


  • Open File Format


  • This means that Rick officially released the specifications for this resource. Utility programs that can edit, or create this resource type are available;


  • Closed File Format

  • This means that Rick did not release the specifications for this resource. As a general rule of thumb, utility programs that can edit, or create this resource type are not available;


Resource Type

ANL: Verse Analysis

Closed file format

BBL: Bible

Open File Format

BRP: Bible Reading Plan

Closed file format

CMT: Commentary

Open file format

DCT: Dictionary

Open file format

DEV: Devotional

Open file format

DIC: Spelling Dictionary

Closed file format

HAR: Harmony

Open file format

Ill: Sermon Illustration

Closed file format

LST: Verse List

Closed file format

LST: Bookmarks

Closed File Format

LOC: Localization

Closed file format

MAP: Map/Graphic

Closed file format. Specifications were accidentally released. User created resources are highly discouraged

MEM: Scripture Memory

Closed file format

NOT: Study Note

Closed file format

OVL: Markup Overlay

Closed file format

PRL: Prayer Request

Closed file format

STEP files

Proprietary file format. Specifications were publicly released. No known tool sets are currently publicly distributed

THE: Thesaurus

Closed file format

TIP: e Sword TIP file

Text file. Editable with any text editor

TOP: Topical File

Open file format