19 September 2010

e-Sword Validation Checker

In trying to find out why the resources from Bible.org do not display correctly on my system, I realized that tools for sanity checking, content validation, and content verification for e-Sword 9.x were still not publicly available.

This tool will do the following:
* Walk through the Description Table, ensuring that the data there is correct:
** Boolean values reflect what e-Sword expects to see for a boolean value;
** Version number correctly reflects the e-Sword Resource Format Specification Version number;
** The resource abbreviation does not conflict with existing abbreviations for that resource type;
** The comments field contains content that is usable, and functional;
** The description field contains content that accurately represents the resource;
(I'm not sure how the latter two will be done, but that is a slightly different issue.)

* Walk through the Copyright Table, ensuring that that data is filled out;
* Walk through the Metadata Table, ensuring that that data is filled out;

For all resources:
* Walk through each displayable table, ensuring that the presentation format is consistent with the resource type and how the table is displayed;

For Bible resources:
* Walk through the Bible table, checking for:
** Missing text;
** Added text;
** Red Lettering in the appropriate places;
** Strong's Number is "correct". The number is found in that verse, even if it is used with an incorrect word;
* Anagignoskomena content is demarcated in blue;

"Missing text" and "added text" to be determined by comparing the number of characters in the verse, with that found in the KJVA, Greek LXX&TR, Hebrew MT, Latin Vulgate, and the average number of characters found in those four versions.

For Commentary resources:
* Walk through the Books table, ensuring that every listed book has content attached to it;
** Remove content along the lines of "name of book";
* Walk through the Chapters table, ensuring that every listed chapter has content attached to it;
** remove content along the lines of "name of chapter";
* Walk through the Verses table, ensuring that every listed verse has content attached to it;
** Remove content along the lines of "book, chapter, and verse number";
* In all three tables check that links to other sources are correctly formed;

For Dictionary resources:
* Walk through the Dictionary table checking:
** Every Topic has a Definition;
** Topics are ordered alphabetically;
** Check that links to other sources are correctly formed;
** If Topics are a numbering scheme such as Strongs, numbers outside of that numbering scheme are not listed;

For other resource:
* Walk through the tables, verifying that there is content that is consistent with the expected content;
Post a Comment