Jump to content

Please read the Forum Rules before posting.

Photo
- - - - -

e-Sword File Naming Conventions


  • Please log in to reply
5 replies to this topic

#1 Josh Bond

Josh Bond

    Administrator

  • Administrators
  • PipPipPipPipPip
  • 2,843 posts
  • LocationGallatin, TN
Offline

Posted 12 September 2011 - 01:02 PM

e-Sword File Naming Conventions

The purpose of this document is to establish a standard convention for the naming of user made e-Sword modules.

Definitions


What does the term “raw file” mean?

Raw files are the modules that are used by e-Sword to display something. For the purpose of this document the term “raw file” will include only these 15 user creatable module types- .anlx, .bblx, .brpx, .cmtx, .dctx, .devx, .harx, .lstx. .mapx, .memx, .notx, .ovlx, .prlx, and .topx.

What does the term “executable file” mean?
This term refers to the files that our users download, and then execute to install the downloaded module into e-Sword.

What does the term “BibleSupport.com Resource Name” mean?
This term refers to the name of a resource as displayed by the BibleSupport.com website.

What does the term “tab name” mean?
Tab name refers to the name e-Sword displays on the tab for any given module. Currently, Bibles (.bblx), Dictionaries (.dctx), and Commentaries (.cmtx) appear as tab names. In this document, we refer to these resources as the Tab Modules Group.

How does e-Sword sort modules for display?

e-Sword always sorts and displays modules by the raw file name. For the tab name to be sorted alphabetically, it must correlate with the raw file name.


The Conventions


Convention #1- Raw File Names

  • All raw file names must be no greater than 250 characters in length, including the file extension.
  • The white spaces in raw file names of the Tab Modules Group may be filled with “_” underscores.
  • All raw file names of the Tab Modules Group must begin with the tab name followed by a dash and then the name, or simply be named the same as the tab name, as in the following examples.
Example:

KJV-King James Version.bblx
-or-
KJV-King_James_Version.bblx
-or-
KJV.bblx

  • All raw file names of the Non-Tab Modules Group must begin with the author’s last name, followed by a comma and the followed by the first name or initial (if known) and middle initial (if known), followed by a dash and the name of the book, article, sermon, etc., as in the following example. All white spaces should be left unfilled.

Example:

Reisinger, EC - God's Will, Man's Will and Free Will.topx

Convention #2- Executable File Names

  • All executable file names must be no greater than 250 characters in length, including the file extension.
  • The white spaces in all executable file names must be filled with “_” underscores.
  • There will be no punctuation in any executable file name, only alpha-numeric characters are allowed.

Example:

reisinger_ec_gods_will_mans_will_and_free_will.exe
-or-
kjv.exe

Convention #3- “BibleSupport.com Resource Names"

When uploading a file to BibleSupport.com, you must specify a "Resource Name". A reminder of the preferred syntax for the Resource Name is shown on the Upload screen. The syntax is: Author last name, Author first name - Resource Name.

Example:

Evans, William - What Every Christian Should Believe.topx

(or .zip or .exe)


Convention #4- Tab Names
The decision on the naming of tab names is really left to the module creator. However, for standardization we recommend the following guidelines.

  • Keep it short! Long tab names take up valuable real estate.
  • Capitals are always a good rule.
  • Be concise; avoid including conjunctions like “and” or “for”, or demonstratives like “the”, or prepositions like “to” or “on”.
  • Always try to use the most commonly known abbreviation, if there is one.
Example:

Name of Bible-The Authorized King James Version
Tab Name-KJV


Convention #5- Tool Tip Content
Verse references should be tooltipped. Brent Hildrebrand's Tooltip 3 will automatically tooltip your verse references or you can use another tool. As an indicator of the importance I place on Tooltip, it was the 4th upload to this website!



#2 pfpeller

pfpeller

    Moderator

  • Moderators
  • 1,107 posts
  • LocationWA
Offline

Posted 12 September 2011 - 02:57 PM

I think I have a little work to do to get in compliance with the standard :).... But it is a very good idea.

Need to have slighltly different guidelines for MySword which cannot have underscores in the names. I do not think they can have spaces either. Dashes seem to be ok though.

#3 Josh Bond

Josh Bond

    Administrator

  • Administrators
  • PipPipPipPipPip
  • 2,843 posts
  • LocationGallatin, TN
Offline

Posted 12 September 2011 - 03:07 PM

Good point, I changed the title to e-Sword File Naming Conventions...

#4 jonathon

jonathon

    e-Sword Fanatic

  • Contributors
  • PipPipPipPipPip
  • 753 posts
Offline

Posted 13 September 2011 - 12:31 PM

For the purpose of this document the term “raw file” will include only these 15 user creatable module types- .anlx, .bblx, .brpx, .cmtx, .dctx, .devx, .harx, .lstx. .mapx, .memx, .notx, .ovlx, .prlx, and .topx.


The following resource types can be distributed by users:
  • .anlx,
  • .bblx,
  • .brpx,
  • .cmtx,
  • .dctx,
  • .devx,
  • .harx,
  • .jnlx;
  • .lstx.
  • .mapx,
  • .memx,
  • .notx,
  • .ovlx,
  • .prlx,
  • .topx
The following resource types can not be distributed by users:
  • .locx;
  • .illx

All raw file names must be no greater than 250 characters in length, including the file extension.




From a technical POV:
  • ISO-9660 Level 1 restricts file names to an 8.3 length.
  • ISO-9660 Level 2 restricts file names to roughly 150 characters
  • ISO-9660-1999 restricts file names to 207 characters.
Suggestions:
  • For Pocket e-Sword, the file name should be less than 20 characters.
  • For MySword, the file name should be less than 30 characters;
In both cases, I'm using the ease with which the file name can be read, as the limiting factor.


jonathon

#5 John Stokes

John Stokes

    New to Bible Support

  • Veterans
  • Pip
  • 2 posts
Offline

Posted 17 June 2014 - 12:35 PM

I just downloaded all of the Spurgeon Sermons to my computer for e-Sword, but can't find them using Esword. They are on my computer. When I downloaded them I chose "Save" instead of Open, before selecting download. Any help would be appreciated. Thanks, John



#6 John Stokes

John Stokes

    New to Bible Support

  • Veterans
  • Pip
  • 2 posts
Offline

Posted 17 June 2014 - 12:46 PM

I found the Application S/W using "Explorer" and followed the screen prompts. Now I am good to go by selecting "Tools" tab and then Reference Works. ... Thanks to all who might have "been there for me (:>). ... John






0 user(s) are reading this topic

0 members, 0 guests, 0 anonymous users




Similar Topics



Latest Blogs