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.
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.
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!
