This topic is locked
e-Sword has an ever-growing collection of bible modules both Official Modules and Third Party modules most bible modules contain the complete text of a particular bible translation and nothing else. There are however some bible translations that offer the complete bible text as well as inline footnotes. These inline footnotes can be found int the modules for:
Lexham English Bible
Common English Bible
The International Standard Version
The Scriptures 2009 Edition
Each of the above translations add the text of footnotes to verse by placing the footnote text inclosed in brackets [] in colored text. While this is a good way to include the notes it can also cause a cluttered looking bible text if a particular bible translation has a large number of footnotes.
There is another way to add notes to bible module that can be found in modules for both The Amplified Bible and The English Standard Version. Modules for both of these bibles that include footnotes using Pop Up notes which are triggered by mousing over special text. The special text is presented with a capital letter N followed by a number such as 1, numbering is used in the event that a particular verse has more the one footnote. When a user mouses over the special text a pop-up not will appear containing texy
How are these Pop-Up notes created and added to a bible module?
While e-Sword Tooltip NT can be used to create modules and tooltip bible cross references to create Pop-up notes for those references, it cannot be used to create Pop-Up notes within Bible Module text or any other module for that matter. To accomplish creating Pop-Up notes within Bible Modules the first thing that must be understood is that all modules for e-Sword are in actuality SQL Databases. Being that modules are databases they can edited using a SQL Database Browser/Editor tool.
There are many SQL Database tools available and for working with e-Sword modules in fact there is one that can be downloaded from Bible Support called SQL Database Browser. This tool is basic and straight forward to use however it is somewhat featured limited and not the best for creating Pop-Up Notes.
A better alternative is a program called DB Browser for SQLite, this program is free and more feature enriched for ease of use. These programs or anyother SQL Database tools will easily read an open any e-Sword Modules or any other bible programs modules that are SQL Databases.
This tool can be downloaded here: https://sqlitebrowser.org/
How are module databases constructed
The module databases are made of individulal tables containing all of the required data for each module. Bible modules contain two main tables labeled "Details" and "Bible", the Details table contains all of the information found in the bible's header including the title of the module, the tab name, and any descriptive information about the module. The "Bible" table contains the complete text of the bible with the verses displayed in a grid made up of what are called records this grid is similar in appearance to a spreadsheet as it contains both rows and columns. Each verse is given it's own record or row in the table as such depending on the bible translation a bible table will contain more then 30000 records. The Databases also contain was is called an indices for the module which establishs the order in which the module is presented in, the case of bible module the indices are usually in the following format Book, Chapter, Verse.
To add pop-up notes to a bible module you will need to download and install an aforemention SQL Database Browser/Editor tool such as DB Browser for SQL.
Note before working on any modules that are installed into e-Sword, copy the module you want to edit to another folder. Modules in your e-Sword folder in the Program Files(x86) cannot be written or saved to!
Once you have DB Browser for SQLite up and running the programs interface will consist of the standard Windows menu across the very top, a row of buttons just below the menu. The Buttons are labeled New Database, Open Database, Write Changes, Revert Changes, Open Project, New Project, Attach Database and Close Database
Below the buttons the interface is divided in to two sections or areas, one section contains four tabs labled Database Structure, Browse Data, Execute SQL and Schema. The other section of the interface and consists of two smaller sections, the top section is labeled Edit Database Cell and the lower portion is labeled Remote.
The first thing you need to do is open which ever module you want to edit. You will do this by selecting Open Database from either the file menu in DB Browser for SQLite or by Clicking the Open Database button. Selecting "Open Database" will open a typical file open window from which will will need to navigate to the folder where your modules are stored. Find the module you want to edit select it and then click open at the bottom of the window to open the module.in your DB Browser for SQLite. If the module does not appear in the open files window at first, change the file type in the bottom right corner of the Open file Window from "SQL Databases" to "All Files" and your module should appear in the list of files. Click the module to open it
When the module first opens in DB Browser for SQLite, it will open in the tab labled "Database Structure" This tab will display the complete structure of an e-Sword module which will include all of the tables within a database, the indice or index for the database and other items that you will not need to worry about.
With the module/database open in the the first thing you need to do is create a new table in the database where the pop-up notes will be stored. Creating the table will require the execution of what is called an SQL statement, this is an instruction to DB Browser for SQLite. which will create the new table for the pop-up notes here is the required statement:
CREATE TABLE Notes (Book INT, Chapter INT, Verse INT, ID TEXT, Note TEXT);
To excute the above statement select the Execute SQL tab "Execute SQL" Execute SQL area of the DB Browser for SQLite. There will be a box where the above SQL Statement can be pasted. Once the SQL Statement is pasted in to the box, click the Apply Button near the bottom of the box. Clicking Apply will execute the SQL statement a create a new table in the module/database.
The newly created table will have the title "Notes" and five columns labeled as follows from left to right: Book, Chapter, Verse, ID and Note. To access the table you will need to select the Browse Data tab which there is a drop down menu in this area of DB Browser for SQLite from which you can select to view the tables with in the database.
As I mentioned above, in e-Sword bible modules two most common data tables are labled Details, and Bible. The Details table contains all of the information placed in the header of a bible module when creating the module in e-Sword Tooltip. The Bible table contains the text of the bible. After you have created a notes table, it will be added to the list of tables in the module's database.
From the dropdown menu in the Browse Data area select the newly created Notes table to view the table, which will be empty save for the column labels mentioned above.
To create a pop up note you well enter the following data in the first line of the table working from left to right. In the first cell under the heading Book you will enter the number of the bible book as used by e-Sword. BIble books are number from 1-66 starting with Genesis and emding with Revelation. The books of the Apocrypha are number 67-73.
As example of a note I will be using Genese 1:5 as this is the first verse in The KJV with a footnote.
So under the heading Book in the Notes table the book number 1 goes in the first cell below the heading, in the next cell to the right under the heading Chapter enter the number 1 as the chapter in the example above is Chapter 1. Moving to the next cell to the right under the heading Verse the numbered entered in the cell will 5 for verse 5.
Now the next column to the right is labeled ID this is were you will put the the special text to indentify the footnote in the bible verse. All e-Sword modules with pop-up notes use an Alpha-Numeric combinaton of a capital Letter N and a number such as 1 again numbering is used in the event a verse has or will have more then 1 pop-up note. So in the first cell under the heading ID enter N1 as the identifier for the note, the next cell to the right is labled Note this is where you will enter the text that will appear in the pop-up note in e-sword. Each note will require the following two small bits of html code to include with the note next <RF> and <Rf>. The first piece of html code will be place at the start of the of note text and the second html code will be place at the end of the note. You can type the note's text in the box located in the Edit Database Area to the right of the Notes table
Here is sample of what a typical note this looks like:
<RF>While the rest of chapter 1 uses ordinal numbers (eg. second, third, fourth, etc.) verse 5 actually uses the Hebrew word (ech 'ad), which is the cardinal number one. This is different from the ordinal number meaning "first" which is represented by the Hebrew word (rish'on). Thus it literally reads, "one day" and not "the first day." <Rf>
The above note text is taken from a project I am currently working on
Once you have finished typing the note text in in the cell for the note click the Apply Button under the box to enter the note into the Notes Table.
If you have done everything above correctly your new Notes table will now contain your first note
There are couple of more steps that must be taken in order for the Note Identifier from the Notes table to appear in the text of the bible versr. You will need to select Bible from the dropdown list of tables to open the Bible table. The Bible table has four columns with the headings Book, Chapter, Verse and Scripture, the first three are used the same way as in the Notes table. The fourth column is labeled Scripture this is the where the text of each bible verse is located. Select the cell with bible verse you created the note for, when you do this the text of the verse will appear in the Edit Database Cell box to the right of the table. The text of the bible verse will be highlighted in blue, in a box, click the text in the box once to turn off the highlight and a cursor will appear in the text of bible verse.
Move the cursor to the part of the verse that the note you created is for, with the cursor to the right of the particular section of the verse press space and then add the following piece html code: <N1> click Apply to enter this code into the bible verse.
The bible verse in the Bible table will look like this:
And God said,<not>N1</not> Let there be light:<not>N2</not> and there was light.<not>N3</not>
Again the text above is from a project I have bneen working on as you can see this verse has 3 different notes
Once you add the <N1> code into the verse click Apply to enter the new bible verse text into the table.
One final step requires clicking the "Write Changes" button to write or save your edited database (again make sure the module you are editing is NOT in your e-Sword folder).
Click the Write Changes button to save the module/database
Now navigate to the folder you copied the module too and copy it from that folder, then open your e-Sword folder and paste the now edited module into the folder, replacing the original file.
Note you can move the original file from your e-Sword folder before copying the edited module if you move the original file first, pasting the edited file will avoid overwriting the original file
Once the file is copied into your e-Sword folder and close the folder and Open e-Sword if it is not already open, find the bible translation you edited/modified. Find the verse that contains the indicator for the pop-up note. The note indicator will appear colored Gold and in Superscript text as shown below:
Gen 1:1 In the beginning GodN1 createdN2 the heavenN3 and the earth.N4
Again the above verse is from a project I am working on
Move the cursor over the note indicator and the pop-up note will appear in box with a light Orange background. Note the background color of the pop-up notes cannot be changed.
While the background color cannot be changed you can make the text more dynamic by using html codes in the text of the notes to create effects such as Bold, Italic text and Underlining
Bold - <b> </b> The text in between the tags will be bold, and stand out against text around it, the same as in a word processor.
Italic - <i> </i> Also working the same way as a word processor, italics displays the text at a slight angle.
Underline - <u> </u> Again, the same as underline in a word processor.
For notes with more then one line of next a page break can placed in the note using the <br> html code
Font colors and font face can be changed in a note using the html codes show below:
Font Color - <font color="#??????"> </font> Change the color of a few words or a section of text. The 6 question marks represent the hex color code the name of the color can also be used
Font Face - <font face="?"> </font> To show text in a particular font, use the font name such "Helvetica" or "Arial" or "Courier". Be aware that using some fancy font from your computer means that the person viewing that page must also have that font installed on their computer too, otherwise it will look totally different to them.
For a comprehensive list of the color names and hex codes click the link below:
Emphasis can be added using the html codes shown below:
Emphasis - <em> </em>Used to emphasize text, which usually appears in italics, but can vary according to your browser.
Strong Emphasis - <strong> </strong> Used to emphasize text more, which usually appears in bold, but can vary according to your browser.
Pop-up notes can also contain lists by using html list codes, there are three ways for specifying lists of information. All lists must contain one or more list elements.
Lists may contain −
<ul></ul> − An unordered list. This will list items using plain bullets.
<ol></ol> − An ordered list. This will use different schemes of numbers to list your items.
<dl></dl − A definition list. This arranges your items in the same way as they are arranged in a dictionary.
When making a list each the codes <li></li> must be place around each item in the list as seen below:
<li>Beetroot</li>
More information about working with lists can be found here:
Edited by Tj Higgins, 15 September 2022 - 06:18 PM.
