-
Notifications
You must be signed in to change notification settings - Fork 6
Menu Items
In this dialog you can set the properties of a project.
You can change the name of the project.
By default a project is editable, but you can set it non-editable. In that case the project cannot be changed or deleted.
You can add or remove books.
When adding books, you can either import a book from file, or add a book using an empty template.
You can set the versification system of the project, and the language. If the language is set the names of the books of the Bible can assume their localized names, instead of the English names. Some of the languages may have a localization of the numerals also. If this localization is there, the numbers of the chapters and verses in the printout change, for example the 1 may become a Û±.
You can set that a project depends upon another one, and that the dependency runs through a filter. This means that the text of the original project is taken, runs through a filter that changes the text, and then comes in the current project in the new form. This can be useful for creating a diglot. The filters can be managed in menu Preferences | Filters.
There is also a setting for whether to check the spelling in the projects. If this option is ticked, then one or more dictionaries should be selected through the "Dictionaries" button.
This dialog is accessed through menu File | Project | Properties, then button Dictionaries.
The dialog lists the dictionaries that are used for checking the spelling of the text of the project.
Press button "Connect" to connect to a dictionary and add it to the list.
There are various types of dictionaries that can be added.
-
"Project Shared Dictionary. This dictionary belongs to a project. It is called "shared", because if collaboration is used, the dictionary is shared with other workstations.
-
Dictionaries that have two-letter names, such as "en", "he", "en_ZW", and so forth. These are dictionaries that are installed on your system. Bibledit does not know what these abbreviations mean. Some of them can be guessed. It depends entirely on which dictionaries you have installed on your system.
-
"Global Dictionary". This is one global dictionary provided by Bibledit.
To disconnect a dictionary, select it, and press the Disconnect button.
If a dictionary is "disconnected", it remains on disk. This dictionary is no longer used to check the text of the project.
Some dictionaries can be edited, and others cannot. If a dictionary can be edited, then the "Edit" button is sensitive. If this button is clicked, all the words in the dictionary become visible. These can be edited, and if Ok is pressed, these are saved to disk.
If spelling of text is to be checked, Bibledit consults all the dictionaries that are in the list. It starts from the top one, and works to the bottom, in order to find the word. If you wish to use another order, you can drag a dictionary to another position.
Bibledit accesses the dictionaries through Enchant. Enchant supports a variety of spelling check programs. It supports Aspell, Hspell, Ispell, MySpell, and so forth. Any dictionaries installed on your system for these spelling checkers will become available to Bibledit through Enchant. For example, if Dutch spelling checking is desired using Aspell, then a package like with a name like "aspell-nl" should be installed. Once done, this language is available.
This dialog is accessible through menu File | Project | Properties, button Dictionaries, button Edit.
In this dialog the user can edit the contents of an editable dictionary.
Text can be added to this dialog, or removed.
Button "Sort, remove duplicates" does what it says, it sorts all the words in the order that the dictionary engine would order them, and it removes any duplicates.
The user can import words from another dictionary, or export them to another dictionary.
The user also can import from a file, or export to a file.
Whenever an import is done, the result is sorted and duplicates are removed.
The user can count the words in the dictionary.
The assistant for viewing changes in a project. It can show you the changes that have been made in the project.
-
You can view the changes since your last review.
-
You can view the changes made a date and time to be chosen by you.
-
You can view the changes that have been made between two dates and times to be chosen by you.
After pressing Apply, some processing will be done and then the changes will be presented to you.
Note. If a change is made in the text, and the changes are requested straight after that, the change may not have been recorded yet. In that case wait a short while and do it again.
This sends and receives your Bibles. It works when you have enabled collaboration for one or more Bibles. Normally the collaboration system send and receives the changes made in Bibles. It does that at intervals as set up by the user. When choosing "Send / receive" through the menu, sending and receiving Bibles is done immediately, regardless of the interval that was specified by the user.
Give the name of the stylesheet that will be created, opened, and attached to the project.
Depending on the type of stylesheet that was selected, more or less styles will be contained in this new stylesheet.
A basic stylesheet contains only a handful of styles, and the full stylesheet contains them all.
By editing the stylesheet of a project, the number of supported markers can be extended. Completely new markers can be added too, but this is not recommended. It is recommended to stick to the USFM standard. A style can be edited by opening a stylesheet, then switching the Edit mode on, and then editing that style.
A variety of data can be backed up through this assistant.
When backing up up a Bible, normally the Bible now focused in the editor will be backed up. You can choose another one.
When backing up Notes, all the available notes will be backed up.
When backing up a Resource, normally the Resource now focused will be backed up. You can choose another one.
This backs up really everything Bibledit knows about.
Depending on the amount of data that you have , it may take a good while to create this backup.
This type of backup is recommended for safekeeping all your data, and when you'd like to transfer all your data from one computer to the other.
If Bibledit starts, and notices that it has no data, it will ask for a complete backup. A complete backup is one that was made with the "Everything" option.
The Restore Assistant allows you to restore a Bible, or the Notes, of Everything. When restoring everything, the data will be available after restarting Bibledit. More information is available with the Backup Assistant, as Restore and Backup complement each other.
Keyterms can be deleted from Bibledit's database.
After deleting a collection of keyterms, the change reflects in Bibledit after restart.
When all collections have been deleted, then Bibledit reverts to using the standard set of keyterms that came with the program.
The Import Assistant can import a variety of data into Bibledit. The various options are described below.
Bibledit can import existing Biblical text. It imports various formats of the texts. These formats are described below.
Bibledit can import USFM text.
If it says that a file is not in Unicode, it is recommended to open this file in gedit, and then save it in UTF-8 format. The program "gedit" is an editor that comes with Linux. Other editors will work well too.
Bibledit can import text that has been exported from BibleWorks. This is how to do it: In BibleWorks choose Tools - Export Database. Export the Bible of your choice to a file and save it in Text format. Then do the Import in Bibledit.
Data from the Online Bible can be imported. Bibledit contacts the Online Bible and retrieves data from it.
To get this to work, it is important to ensure that the Online Bible and Bibledit share their reference. If this works, it means that Bibledit can contact the Online Bible.
The Import Assistant has an option to import data from the Online Bible. After you choose this option, the Assistant will check that it can contact the Online Bible. If this is the case, the next step is to choose which Bible of the Online Bible to import. After that the import starts.
Import will take a very long time due to how the interface has been built.
You can cancel the import at any time. Whatever has been imported will be preserved. When continuing with the import next time, whatever has been imported already will not be imported again. That saves time.
Importing raw text involves manual labour. The following steps would be required:
-
View the USFM code. This can be done through menu View / USFM code, or keyboard accelerator Ctrl-\ (Control-Backslash).
-
Switch on the USFM checker. See menu Check / USFM. This opens a new window.
-
Paste some good text in the editor.
-
Press button "Discover markup", and see how it goes.
If the markup is not discovered properly, you will need to enter the USFM codes by hand. The essential ones are \c, \p, \s and \v.
Keep doing this for each chapter of text you'd like to import.
At the end of all, when all text has been imported into a book, chapter 0 needs to be set as well, else without that Bibledit won't work well with the imported text. Setting chapter 0 is usually done by simply applying the "c" marker in the editor, choosing chapter 0, and pressing OK.
Note. At any stage in the text import process, the user can filter the text. Select the filter to apply, then click button "Filter text". Filters can be created through menu Preferences | Filters.
Note. There is an option "Verses are at line start". if this one is ticked, when discovering the markup, the engine only considers verses that are at the start of the line.
Note. In some raw text footnotes or cross references are included in the text. See the following example, where one would like to import the following raw text:
"5 Don't forget what happened to those people that the Lord rescued from Egypt. Some of them did not have faith, and he later destroyed them. Ex 12.51; Nu 14.29,30. 6 You also know about the angels who didn't do their work and left their proper places. God chained them with everlasting chains and is now keeping them in dark pits until the great day of judgment."
There is a cross reference in 5: Ex 12.51; Nu 14.29,30.
To import this raw text properly, you need to tick the option that the verse numbers are at the start of the line. Then recognize the text by clicking on the button. It will now have recognized only verse 5. You need to put a new line before verse 6, and manually add the \v before it. The switch to formatted view, and cut the cross reference to the clipboard. Then insert a new cross reference, and paste that text into the dialog.
The same technique can be used for footnotes or endnotes.
This gives information about how to get a list of references into Bibledit, into the References Window.
This imports a stylesheet.
This imports project notes.
This allows you to import keyterms.
The file that will be imported has to adhere to certain standards. The various files with keyterms that come with Bibledit show what the format of the textfiles should be.
There are several different types of textfiles than can be imported.
-
There is the Standard textfile. Samples of this type of file are in the bibledit distribution or are installed in, normally, /usr/share/bibledit-gtk. These files start with "keyterms" and have the "txt" extension. Looking for files like "keyterms*txt" will give them.
-
There is the OTKEY.DB file. A file with that name comes with the bibledit distribution.
-
There is the KTREF.DB file. A file with that name comes with the bibledit distribution.
-
There is the data produced by the "Key Terms in Biblical Hebrew" project. This is supported too. It is included with bibledit as KTBH.pbu. If an update is available, you can import it through the Import function. At KTBH they would be very grateful if they could get some user feedback on our data. The KTBH project is still formally under review, and valuable user feedback is needed.
The keyterms will be imported into a collection. This should be a new collection, one that does not yet exist.
If you have messed up the keyterms by importing garbage, the collection that was imported can be deleted again.
Any keyterms that have been added become available after Bibledit has been restarted.
Any errors can be sent to the Bibledit bug trackers, apart from errors in the database provided by Key Terms in Biblical Hebrew project.
You can export the data from Bibledit. All export is done from the Export Assistant. See menu File / Export. You can export a Bible, or the References, or a Stylesheet, among other things.
In case that you export everything, it will ask you to select a directory to put all the USFM files in. Bibledit will put one USFM file per book into that directory. Or if the export if compressed, all the files will be stored in a zipped archive.
In case that you export only the changes, matters are slightly different. This only exports the changes since last time you did this, or since a certain date and time. This can be chosen.
When exporting a Bible to BibleWorks Version Database Compiler, a text file is produced that can be imported in the BibleWorks Version Database Compiler for display in BibleWorks. See the BibleWorks online help for detailed information.
An attempt is made to produce a valid OSIS file. The standard transformation is the recommended one. Or if the OSIS file is going to be used for creating a Go Bible, you can produce a variant for the Go Bible Creator.
When exporting to a SWORD module, the module is created and installed straightaway. Normally Bibledit will install the SWORD module to subdirectory .sword in the home directory, but this can be changed. Provide a name for the module and export it. After restarting the Sword enabled Bible reader, the module should be visible in the program.
While creating a Sword module, some settings need to be made.
Module path is the directory where a zipped module will be stored. This module is fit for immediate distribution.
Exporting to SWORD produces an intermediate OSIS file, which is placed in the home directory. This file will be compiled by osis2mod, the SWORD compiler.
Currently there are two methods for exporting to an OSIS file and a Sword module. There is the "Old method". This divides the text into books, chapters and verses. Then there's the "Recommended transformation". This divides the text into books, sections and paragraphs. At the moment of writing the osis2mod compiler is not capable of producing a proper Sword module out of the OSIS file created with the new method.
If one method fails to produce the result that you'd like to see, try the other one.
You can also export to an OSIS variant that is fit for the Go Bible Creator.
This will ask you where to save the file, and then does the export. The file can be opened in the various wordprocessors that support OpenDocument, such as AbiWord, KWord, OpenOffice, etc. The main purpose of this export is to be able to transfer the formatted text into other applications. For that reason several style settings, like two columns, are unsupported.
It makes use of a template. This template is a simple document in OpenDocument format. Under normal circumstances this template is stored at /usr/share/bibledit-gtk/template.odt. If you really like to change the OpenDocument export, you can modify the template.
This will create a Go Bible. It runs on a cell phone. You need to have a working Java runtime environment. This can be installed through your distribution's software installation mechanism.
You can export all the references that are now in the References Area. This saves them to a file on disk, one references per line.
You can export the stylesheet. The one that displays will be exported.
You can export the notes and save them to file in a format that is easily readable.
The keyterms can be exported to a web page. The collection of keyterms that the window for checking keyterms shows will be exported.
This dialog is for printing a project.
Press button OK to let Bibledit generate a .pdf file with the project data.
It is possible to print only a part of the project. The dialog shows whether the full project will be printed or only part of it. It does that at the "Portion:" label. Press button "Change" to change which portion will be printed.
Press "Options" to show more options.
Option "Write the references in the notes in full". This option scans the text to be printed in the footnotes, the endnotes, and the crossreferences. If it finds any references to verses of the Bible, it will include these with the text. For example if there is a crossreference that says "Acts 10.5; 1 Joh. 1:5", then it will include the full text of these verses in that crossreference. This can be useful for checking purposes, whether the crossreferences are correct.
Allows you to select which portion of the project is going to be printed.
For help on the books selection part, see Selecting books.
To print only a portion of a certain book, double click on the portion at the right of that book. Then you can choose to print from a chapter.verse till another chapter.verse.
To exclude a book from printing, just unselect it.
Everything can be done with either the mouse or with keyboard shortcuts.
Bibledit stores every single change that has been made in the text of the Bible.
You can go back to any date in history, when the text was edited, and view how the text looked at that date, or even revert the text to that state.
When you choose this menu option, the dialog appears with the book and chapter selected that is now opened in the editor.
Bibledit displays all the dates and times that a changes was made in that chapter.
If you double-click on a revision, or press Enter, then the dialog shows the changes that will be applied to the current text if you were to revert to that revision.
Text that will be inserted is shown in bold, and text that will be deleted is visible in strikethrough.
If you press button OK, Bibledit will revert to the "previous text".
Bibledit supports simple project status reporting. In this dialog the status of a project or part of the project can be set.
The dialog consists of four columns. The first one shows all the books, the second one shows all the chapters in a particular book, and the third one displays all the verse in a particular chapter. Finally the last column shows all the tasks that have been defined for the project.
To mark a particular task as being done for a whole book, just select that book in the list, and put a tick in the task.
To mark a task as being done for just one chapter, select the book and the chapter in the list, and put a tick in that task.
And to mark a task as being done for one verse only, select book, chapter, and verse in the lists, and tick that task.
-
If a task is checked, it means that it has been done.
-
If a task is unchecked, it means that this one has yet to be done.
-
At times there is another symbol that indicates that the task has not been consistently completed. Such a state occurs when for example the status of a chapter is displayed, and not all the verses of that chapter have a particular task completed. Some have, and others don't.
-
To set the task that have been done for a range of books at once, select the boosk you want, and put tick the task that has been done for that book. Tasks can also be set for a range of chapters, or a range of verses.
When speaking about references, we refer to the list of references available in the references window. It is a list of verses, e.g. Genesis 2:2.
References are loaded in the references window.
References can be loaded as a result of:
- A search operation.
- Opening a list of references, through menu View / References, then click [actions] and then "Import a list of references".
- Checking.
- Getting them from a project note.
When a list of references is opened, up to three words can be chosen to be highlighted in the text editor, when a reference is activated in the references window.
The references list is used to quickly navigate to the verse referred to. Just click on the reference and Bibledit presents that verse in the text editor.
Navigation aids:
-
Next Reference (F6): Actives the first reference, or if one is active already (except the last one), the next one.
-
Previous Reference (Shift+F6) Actives the first reference, or if one is active already (except the first one), the previous one.
A list of references can be saved through menu, File | Export. See information about exporting data.
Any references that are at present in the references window can be hidden for the future. Click [actions], then "Hide ... from now on". It won't come back in the future.
The list of references that has been hidden can be seen and edited via [actions], then "Manage the hidden references".
To print references, including the text they refer to, type Ctrl+P or choose menu File - Print. Follow the screen.
When working in a text and going to another reference, it is important to have a way to go back to the original reference.
The Previous/Next in the toolbar (green arrows to the left/right) can be used to go to the the original reference in the text editor. This is the text before any reference of the references window was activated.
Select the text to copy with the mouse, and press Ctrl-C. This will copy the selected text to the clipboard.
All the verses in your translation have other verses related to them in some way. To see these related verses, choose menu View | Related verses. A new window will open. This is called the Related verses window.
This tool may be very useful during translation. If you ever had to translate a difficult word, and can't remember how this word was translated before, then the Related verses window may show you the related verse. If you then click on that verse, you may be able to find out how again this word was translated.
Access this dialog through menu View | Project notes. Project notes are notes that concern the entire translation project.
In this dialog settngs can be made that influence which project notes are displayed, and how they are displayed.
The top part of the dialog deals with the notes selection, that is, which notes will be selected for display.
The bottom part of the dialog deals with the notes display, that is, how the notes will be displayed.
A note must satisfy four conditions to be selected for displaying.
The first condition to be satisfied is which reference or references the note belongs to.
The second condition is the date on which the note has been edited.
The third condition is the category to which the note belongs.
The fourth condition is the project to which the note belongs.
For example if you wish to select all the notes in the current chapter that have been edited today, then tick these conditions: "Notes that have the current chapter", and "Notes edited today", and "Notes of category All categories", and "Notes of project any".
Another example. If you wish to select all the notes that fall in category "For church", then tick these conditions: "Notes that have any verse", and "Notes edited at any time", and "Notes of category For church", and "Notes of project any".
"Order center around current reference". When this is ticked, Bibledit makes an attempt to display notes ordered by how close they are to the current reference. That is, for example, if the user display Matthew 10:2, then the notes that are nearest this reference are displayed visibly, and notes further away are moved away a bit.
"Include in title - project". If this has been ticked, then also the name of the project the note belongs to will be shown in the blue link, in the Notes Area.
"Text - summary". Only the first few words of the note are displayed. This allows many notes to be displayed in a small space. This is supposed to give a better overview of which notes are available.
"Text - add text of the references". If this is ticked, Bibledit displays not only the references of the notes, such as Matthew 1:1-2, but it displays the actual text of those references too. This has been found useful in cases that worksheets had to be produced for a team discussing some notes.
Build a concordance of the current version, all books. Display a new window with all the words, one tab sorted by frequency and the other sorted alphabetically. Clickable links to the verses where the words occur.
Greek, English versions of the Bible keyed to the current editor verse. Cross references with clickable links.
Bibledit shows the outline of the book that is being edited.
The outline can be seen in the Outline window, accessible through the View menu.
All the headers and titles that are in the book are visible there, with the chapters and verses they start with and end with.
The header or title that has the cursor will be focused.
If you double-click on any header, or press Enter, the chapter belonging to that will be loaded in the editor.
Notes.
-
Headers and titles that are in chapter 0, that means, before chapter 1, do not show up as such, but as chapter 0 without any verse-references.
-
There are no heading endmarkers if the heading is followed by another one.
Rearrange all the windows in a nice way, with Bibles on the left 2/3 of the screen, and resources in the right 1/3.
Links to web tools (and on Windows, Bibleworks) that open those tools to the verse that is currently focused in the editor.
This dialog comes up when you choose menu Insert | Footnote, Endnote or Crossreference.
The dialog aids you while inserting Bible notes. These notes are notes on specific parts of the text of the Bible.
The numbering can be set to automatic, or no numbering at all, or a certain character.
You can set whether to automatically insert the current reference in the Bible note. If you do insert it, then you can set whether to include the chapter number, and the verse number, and what the separator between them will be. A suffix can be entered too. It will show how this is going to look in the text.
Note content can be added in the dialog too. Press the "Add content" button. A new area will be added that allows to insert a marker with its content.
The marker to be used can be selected in the combobox.
The content to be inserted can be typed in the text entry.
If "Remember content" is ticked, this content will be remembered for the next time you insert a Bible note.
To get rid of this content area, press the "Remove" button.
Tick this function to tidy the references you insert. You can influence the process in the settings.
It is possible to save a certain configuration in a template. The "New" button will make a new template, and the "Delete" button will delete the current one. If no template name is given, the default one will be used. Data is saved in a template only on pressing the "Ok" button.
The dialogs for inserting Bible notes have been designed to improve efficiency and speed.
When the dialog opens, the first entry gets focused, and you can type text there. On pressing Enter the next entry focuses, and so on, until the Ok button gets focused. Pressing Enter again inserts the note.
To start checking terms in Bibledit, in the Checking menu choose Key terms. A new window will open. This is the "Check keyterms" window.
At the top of the window you can choose which collection of words to check.
The window will also display a list of keyterms in that collection.
Let's check the translation you made for the word "lamb" in the New Testament.
Choose the Flora and Fauna of the New Testament.
In the list of keyterms, locate the first "lamb". Click on the link to activate this keyterm.
Extra information about "lamb" will be displayed.
Any references that have the word "lamb", or should have it, will be displayed as well.
If you'd like to more closely examine or change a passage that has the word "lamb", you can click on the blue reference. For example, when you would click on John 1:36, the editor would then go to that references, and you can change if needed.
Still further down a list of correct renderings for "lamb" becomes visible. Initially this list is empty.
To add a rendering, click once on , and then press Enter. Type the word, e.g. "wundlu", and press Enter. You'll find that, if this rendering, the word "wundlu", is found in the texts, it shows it as bold.
A faster way of adding renderings is to select text and then press Ctrl-C as if copying that text to the clipboard. The rendering will be added as a whole word, and if there was any capital in the word, the case sensitive option will be set too.
In the renderings you can set whether a rendering is supposed to be a whole word, and whether the word is case sensitive.
To remove a rendering from the list, click once on the word to be removed, then press Enter, remove the word, and press Enter again.
-
The keywords are divided into collections. If you select a particular collection, then the keyterms in the other collections are not displayed.
-
The renderings are stored with the project.
-
If the user clicks a verse, the editor will also display that verse.
-
It is possible to have the keyterms in the active verse show up while you are translating. The renderings, if any have been entered, will show up too. This will help the translator, so that he can choose the same rendering if the same keyterms occurs in that verse. To show the keyterms, choose menu View / Keyterms in verse.
-
New keyterms can be imported, existing keyterms can be exported, and collections of them can be deleted.
-
Some references have the keyterms only implied by their context. That means that the key terms does not occur in the verse literally, but only by implications. To mark such verses correct, select a reasonable part of the verse and add it to the renderings. Then, the verse will be marked correct. Or just leave it as marked incorrect.
Bibledit includes a spelling checker. If a word is misspelled, it will be underlined in red. If the user clicks on that word with the right button of the mouse, a menu appears that allows the user to handle this word.
Spelling checking is switched on or off in the Project properties dialog. If "Check spelling" is ticked, then the spell checker is switched on, else it is off. When switching the spelling checker on, and if there are no dictionaries added yet to use, then naturally all words are considered misspelled.
Adding dictionaries is done in the same dialog. Button "Dictionaries" gives access to all available dictionaries on the system. If that button is clicked, then a dialog "Dictionaries" opens. More help is available about this.
If a word is misspelled, and the user clicks on it with the right button of the mouse, then a menu with Spelling suggestions opens. These give possible corrections for the word. If one such suggestion is chosen, then the word will be replaced with that suggestions. It also is possible to add the misspelled word to the dictionary. It will be added to the first editable dictionary in the list of dictionaries. Another option is to Ignore all. This means that for this session the misspelled word is ignored.
-
There is some information about how apostrophes in e.g. "it's" are handled.
-
The Check menu allows the user to go to the next or to the previous spelling error. If the user does this, the cursor will move to another spelling error. If there are no more spelling errors to go to, it will go to another chapter.
-
It is possible to approve misspelled words in bulk. See menu Check / Spelling / Bulk.
Bibledit contains a number of tools to check the text. Most of these are accessible through menu Check.
Any undesired checking results can be hidden for the future, so that they don't appear again if the same check is ran again. To hide such a result, right-click in the References Area, and choose "Hide from now on".
This check, accessible through the menu, Check - Characters - Inventory, gives a list of all characters in the project, and the count of each character.
Due to newline handling on Linux the character counter will only include U+000A but not U+000D. After importing the file the U+000D completely disappears and so will not be counted.
A character can occur anywhere in the output html file, depending on how sorting is done.
The file will be visible in the Internet browser, which will supply its own default font so as to ensure the character becomes visible. No particular font is enforced.
The check does not handle legacy encoded data. This is because anything with such data will be converted to Unicode when imported in Bibledit, and so the character counting check will never encounter anything else but Unicode.
Paratext had a check called "Compare Punctuation". How do I compare punctuation in Bibledit?
Comparing punctuation in Bibledit is done through the Advanced Find functions.
Open the first project, and search for e.g. a question mark. The search results will be loaded in the References Area.
Open the second project, and go to advanced search, and search for the question mark again. Remove the search results from the ones already in the References Area. The References Area will now contain the verses that do have the question mark in the first project, and not in the second.
Next do it the other way round. Search in the second project, then with advanced search in the first. The References Area will now contain the verses that do have the question mark in the second project, but not in the first.
Checks whether punctuation that is part of a pair makes a complete pair. For example, the opening bracket [ also needs the closing bracket ].
The check knows about 160 matching pairs of punctuation, and checks them all.
Pairs that should not be checked can be ignored. No reports will be given on these characters.
This check looks for patterns that are unwanted. For example, when the pattern " ?", that is a question mark preceded by a space, is unwanted, enter this in the dialog box of the check, and from now on this unwanted pattern will be reported.
This looks for unwanted whole words in the text, and reports them when they have been found.
In the dialog, you can enter a list of whole words to be looked for, one word per line.
This check aims to find repeating words, as sometimes, but not always, repeating words are a mistake. For example if the text has "Jesus said said: Whoever follows me ...", then the "said said" is a repeating word entered by mistake. This check will find these.
This check will also find repeating words that are not a mistake. For example consider this USFM text:
\x - \xo 1.6: \xt Matt. 10.2; 3 John 1:1.\x*
This check will say that the word "1" repeats. It does so because the crossreference "3 John 1:1" has a repeating "1". Both chapter and verse are 1. To prevent these false hits enter an "Ignore" word of ":". If this colon is entered in the list, it no longer will find the "1" repeating.
Some languages have words with reduplicated roots which could be separated with hyphens, e.g., manuk-manuk. The check will mark "manuk" as repeating. If the hyphen (-) is entered under the "Ignore" button, then this words will no longer be marked as repeating.
Some of the checks produce references in the reference area. The references so produced can be used to quickly go to the relevant places in the Bible. And the references can also be printed.
The tool can be accessed through menu / Tools / Transfer project notes to text.
This tool does only one thing. It copies the project notes into the currently opened project.
It does that by going through each verse of the project that is now opened in the editor. At each verse it looks at which project notes would display if that verse were visible in the editor. It then copies the text of those notes into the text of the project. It the text of a note is copied into the project, it does not overwrite the data that is already in the project, but it just appends it.
This tool can be useful in cases that somebody wishes to have some way of printing a subset of project notes along with the text, so that checking questions could be printed on the same page as the verses they refer to. To do this, the notes can be imported in some temporal project, and then a "Parallel Bible" could be created that includes that temporal project that now contains the notes.
Opinions vary on whether origin references in footnotes and crossreferences are useful. Some say that they are useful because they indicate the verse to which the note belongs. Others say that these references are just clutter and that the information is clearer without them.
A tool is available that can add or remove the origin references of all the Bible Notes in one go.
See the USFM documentation for footnotes, endnotes and crossreferences for a description of what the origin references are.
In the dialog, tick what type of notes to affect: footnotes, endnotes, crossreferences, or a combination of them. If you tick "Footnotes", for example, and leave the others unticked, then only the footnotes in your project will be affected.
Then choose the action you wish to take, whether to give statistics only, or whether to add the origin references or to remove them.
If you add them, you can set how the origin references will look.
Once all settings are made, press OK to process all verses in your project.
Changes that Bibledit will now make cannot be made undone.
Statistics of what has been found and what has been done will be given once through.
Sometimes Bible notes don't have any markers in them at all, they are just plain text. To add the default markers to the note, choose option "Add missing text labels".
The dialog to generate the word lists is available through the menu, Tools, Generate word lists.
It generates a general word list, a list of Hebrew words, and one of Greek words.
It goes through all the data in the project, collects the entries which have been marked, and then inserts the lists at a location defined by the user. Thus it can generate a glossary or topical index.
There are three possible lists: a general word list, a Hebrew word lists, and a Greek word list.
For each of these lists there are some options that the user can set:
-
Process word list: whether to process this particular word list.
-
Add an asterisk to each entry, see below.
-
Add the asterisk only to the first time this particular entry occurs in the section, see below.
Generating word lists is simple assuming that the right markers are already in the data: Just set the options, click button OK, and wait till it is through.
The word list generator uses the entries that are in the data to collect the words to insert in the list.
An entry for the general word list is inserted between the \w and the \w* markers. The Hebrew and Greek word lists use similar markers. See the USFM documentation for full details
When the word list generator runs, it will remove any asterisks () that were appended to the word. When the option "Add an asterisk to each word entry" has been selected, it will then add an asterisk after the word. If the option "the first time it occurs in a section" has been selected also, it will only add the asterisk where this particular entry occurs for the first time in the section. In this case, if for example the word "talent" occurs several times in a section, it will be given as "talent" the first time, with the asterisk, and as "talent" the other times, without an asterisk. The section headings define the size of a section.
The lists of words can be inserted once or more than once in the data. The general word list will be inserted between the markers \zopenwordlist and \zclosewordlist. These markers ought to be on a separate line. If this couple of markers occurs in several places, the word lists will be inserted in several places too. If it occurs once, only one list will be generated, and if it does not occur at all, no list will be generated.
Any entries that are already between those markers will be preserved. If there are entries between those markers, and there is no corresponding entry in the text, this entry will be commented out.
List of usfm markers that indicate the position of a word list:
\zopenwordlist
\zclosewordlist
\zopengreekwordlist
\zclosegreekwordlist
\zopenhebrewwordlist
\zclosehebrewwordlist
The markers that open and close a word list will need to be manually typed in the text at the right location. They are not part of the stylesheet.
Consider the following situation:
The text contains the following general word list entries: Hallelujah, Rabi, Pentecost.
At some place of the data, the list should be inserted, but it already contains some entries:
\zopenwordlist
\p Hallelujah: Praise the Lord
\p Rabi: Teacher
\p Mamon
\zclosewordlist
After running the word list generator, it will look so:
\zopenwordlist
\p Hallelujah: Praise the Lord
\rem Mamon
\p Pentecost
\p Rabi: Teacher
\zclosewordlist
Note the following: (1) the existing entries have been preserved, (2) a new one has been added, (3) one has been commented out, and (4) the entries have been sorted alphabetically.
Note also that any text before the first colon (:) is considered to be the actual entry. If there is no colon, then the whole text will be considered the entry.
Bibledit can replace certain text with other text for printing and export. For example, whenever the text << occurs, it can be replaced with an opening quotation mark. And >> can be replaced with a closing quotation mark.
These texts, and their replacements, can be set through the dialog.
First thing to do is to enable this feature in the dialog.
Next thing is to enter all texts and their replacements. To set a text, click once on the text where it says "Set new text (or replacement) here", then click once again, type the new text, and press Enter.
To remove a text and its replacement, just erase it.
Press Ok to save the values.
Note. When exporting to USFM, no replacement is done.
It has two tabs where settings can be made.
There are four accelerators for inserting standard text into a project note when it is being edited. The text that will be inserted can be defined in this tab.
Every project notes has a category assigned. The available categories can be viewed here. New ones can be added, or categories can be deleted. The order of the categories can be changed by draggging a category to another location, either above it or below it. Whenever a new note is created, the category that is at the top of the list is assigned to that note. If you'd like to assign another category to the note when creating that note, drag the one you need to the top of the list.
Bibledit supports simple project status reporting.
In this dialog the user can set the tasks assigned to the project. Press button "Tasks" to access the list of tasks. By default a standard list is provided, but the user can add and remove items, and reorder them by dragging them to a new position.
The user also can set how long a task will take per chapter to complete it. Press button "Duration" to set these values. The duration can be set as so many days per chapter, for example 0.5 days per chapter.
The dialog for making settings for the user interface.
Bibledit can be set to be a more advanced tool, or a tool with fewer options. In this way the features that Bibledit offers can be tailored to the user's needs. There are various settings for this.
-
When Bibledit is set with only the basics available, it becomes a very simple Bible editor. It has all user defined features switched off. See below for the user defined features.
-
When Bibledit is set with all features available, it becomes a most powerful Bible editor.
-
When Bibledit is set with user defined features, the user can set which of the features are to be switched on.
If for example all features are ticked, except of "Project management", then the user cannot manage a project, that is, the user cannot change projects, add or delete them.
If for example the "Project notes" are unticked, then the user cannot view or edit project notes.
There is a whole lot of other features that can be switched on or off. The best way to see how this works is just switch these off or on and see for yourself how Bibledit looks.
There is an option to remember the most recent verse per chapter. When this option is ticket, it may affect navigation. An example will show how it works.
Let us imagine that the user works in Matthew 2:5. Bibledit will record that the most recent verse in Matthew 2 is verse 5. Next the user goes to Matthew 3:10. Bibledit will again record that the most recent verse in Matthew 3 is verse 10. When the user now instructs Bibledit to go to Matthew chapter 2, Bibledit will remember that the most recent verse in chapter 2 was verse 5. It will therefore go straight to verse 5. When the option is disabled, it would have gone to verse 1. Bibledit will also record that the most recent chapter in Matthew is chapter 2. If the user goes to John, then instructs Bibledit to go to Matthew, Bibledit will remember the most recent chapter and verse for Matthew, and will go straight to Matthew 2:5.
The settings in this dialog are used while inserting Bible notes and work on the references in the notes. If the "tidy" function is ticked while inserting for example crossreferences, then the settings apply.
The various tidying functions are described below.
While inserting references, one might prefer to type, for example "Matthew 1.1". References are usually given in their abbreviated form in the footnotes. Therefore, it should be, for example, "Mat. 1.1". This translate function can do that for you. To make it work for the Matthew case, ensure that this function is ticked, scroll the llist of abbreviations down till you reach the Matthew abbreviation, click on the abbreviation, then click at the right side of it under the Texts column. The text now becomes editable. Enter "Matthew", and press Enter.
If you wish to enter several texts that all translate to the abbreviation of Matthew, type them this way: Matthew | Matth. | Mt.. This means that "Matthew", or "Matth." or "Mt." all get tidied to your language's abbreviation of the book of Matthew.
The Remote Repository Setup Assistant.
See Collaboration for information about what this repository is used for.
This setting allows several people to work together on one project.
Several other settings have to be made, as described below.
The setup assistant will test the content tracker, whether it is able to perform everything that is needed. Normally the test passes, and you can go forward.
In the next page select which action you'd like to take. For a first repository setup, the default action should be chosen.
This is the URL of the repository that Bibledit is going to use. Your system administrator should give you the URL that ought to be filled in here.
Example URLs:
git://biblerepository.com/projects/myproject
git://localhost/repository
file:///home/joe/repositories/myproject
The path should point to an already existing repository, created by the system administrator.
If the repository has been set, the dialog will indicate whether read access to the repository has been granted.
Press the button to clone the remote repository.
If write access has been granted, then things should work fine.
Normally this step will be skipped. But if you really like your data to be pushed into the repository, or if the repository is still empty, then press the button to push your data to the repository. Use with care because it wipes out anything in the repository, and replaces it with your data.
When two users make changes in one line in one verse, and the changes are not compatible, then a conflict will occur. Bibledit will resolve this conflict for you. Settings for that are made in this dialog. You can give preference to "the local data". This means that the data of the other user is lost. Or you can give preference to "the data in the remote repository". This means that your own changes will be overwritten with the changes that are on the server, which actually means that the changes the other user made overwrite your own changes.
When two users make changes in different verses of the same chapter, at the same time, Bibledit will merge those changes.
Keep pressing the "Forward" button and at the end "Apply" the settings.
It creates, edits and deletes filters.
Creating a new filter is simple. Just press button "New", type a name for the filter, choose the type of the filter, and press OK.
Deleting an existing filter is simple too. Select the filter, then press "Delete".
Editing a filter is another simple matter. Select the filter, and type the rules in the Rules window. More about the rules later on.
A filter can be tried out. Press the "Try" button to do that. The text at the left of the button is passed through the filter, and then becomes visible at the right side. Any errors show up there too. The text at the left of the button can be changed to anything.
Depending on the type of the filter, there are various programs that run the rules.
The program "sed" is used for operating the filter. Sed is a Stream EDitor. It takes the input text, passes it through one or more rules, and then outputs it, modifying it on the fly. The modifications are done according to the rules that have been given.
More help about creating rules is in the sed rules reference, and in the regular expressions reference. A wealth of information about sed, and the rules to write, is available at sed.sourceforge.net.
The TECkit package is used for running the filter. TECkit is a toolkit for conversion of data to Unicode. Bibledit uses it only for converting Unicode to Unicode. The package takes the input text, passes it through a set of mapping rules, and then outputs it, modifying it on the fly.
More help about creating the mapping rules is in the TECkit mapping rules reference. More information is available from SIL through the computing index, or more specifically at the TECkit home page.
A free script is used for running the filter. A free script means any script that you can give and that will run in the shell. Here is an example of a very basic script, one that really doesn't filter at all, it only shows how to write a script:
cat inputfile > outputfile
Bibledit searches for a text "inputfile", and replaces that with the input data. It also searches for text "outputfile", and replaces that with the output data. The script then is passed to the shell, and runs there. The output data is then read again and used.
The above script just takes the input file and copies that to the output file.
Any custom script that you made will do here, in any language. The only thing that is important is that the texts "inputfile" and "outputfile" are there. And of course that the script does something sensible.
While the USFM text is ran through the filter, an attempt is made that the USFM codes themselves will not be changed. To protect these codes from being changed, the codes are temporally changed into numbers. The assumption here is that the user will not write filters that change numbers. After filtering the numbers are changed back to the original USFM codes again. This process is transparent to the user, that is, the user does not notice that it happens. This process will work well only if the filters don't change the numbers.
Debugging information.
Creating a new resource can be done through menu File / Resources / New.
Editing an existing resource goes through menu File / Resources / Edit. Creating a resource
When creating a new resource, several settings will have to be made about how this new resource operates. These are described below.
The user can enter the title of the resource. This title is used for easy reference to the resource.
A resource may live on the network, or it may be local. If it is local, it should have files that belong to this resource. These files make up the body of the text of the resources, that is, these files are the actual pages to be displayed. Files can be added to this resource by pressing the button to add files. You can add complete folders too. The whole folder will be added and everything that it contains.
There is a "Home" button visible when a resource is displayed. If this button is clicked, then the home page as given will be displayed. Sample home pages:
-
index.html. This shows the file "index.html" within the local files that belong to this resource.
Special text like "" can be used as well so as to make a home page that depends on the book now opened. See heading "URL constructor" below for more information about that.
Book abbreviations are used when retrieving a resource.
Let's have a look at an example. We will retrieve the book of Matthew. The Resource will retrieve the information through a URL (Uniform Resource Locator). Take note of the following URL:
http://net.bible.org/bible.php?book=Mat
If this URL is loaded, then the book of Matthew will display. As you can see, the book of Matthew is abbreviated using "Mat". If the Resource wishes to get to Matthew, instead of writing the full "Matthew", it uses only "Mat".
There is a button "Abbreviations" on the page. Pressing this button allows you to enter the abbreviations for all the books. The "Books" dialog shows, and you can enter the abbreviations.
An example will show how to enter an abbreviation. We are going to enter abbreviation "83" for book "1 John". To enter this, follow these steps:
-
Make 1 John blue by clicking on it or scrolling to it.
-
Press the right arrow key, or click at the right side of the blue line, as if you were clicking in the second column, the column called "Book in URL".
-
Type “83� (without the quotes).
-
Press Enter.
Press OK when through.
In order to save work, you can also import the abbreviations from another, existing, resource. See button "Import".
The second set of book abbreviations work similar to the first set, as described above. How to differentiate between these will be described below.
This button allows the user to go to the Resource Converter dialog where the required anchors can be written to the files. This is only needed when the anchors are not yet in the file.
In resources types where a URL must be retrieved, this URL constructor is used to assemble the URL to be retrieved. How it works is going to be explained using an example. Let's imagine that we're going to retrieve the Resource for Matthew 5 verse 8. The Resource would like to retrieve the following URL:
http://net.bible.org/verse.php?book=Mat&chapter=5&verse=8
You see that the book is "Mat", the chapter is "5", and the verse is "8".
The URL constructor for this will be:
http://net.bible.org/verse.php?book=&chapter=&verse=
You see that part of the constructor is "". First a left pointing angle bracket, then "book", and then a right pointing angle bracket. The Resource will consult the book abbreviations, and then find that for Matthew the abbreviations is "Mat", and then it will put "Mat" where it has "". It does the same for and .
The new URL will look like this:
http://net.bible.org/verse.php?book=Mat&chapter=5&verse=8
And this is exactly the URL that we'd like to retrieve in the Resource.
The second set of book abbreviations is consulted when the Resource finds "" in the URL constructor.
When you enter a URL constructor, it will be loaded immediately, so that you can see right away what the effect will be of any change that you make. You can also choose the book, chapter and verse that will be tested. There are controls for that too.
If the Resource is not on the network but local, you can just enter the local filename. For example:
.htm#v.
This results in:
mat5.htm#v8
At the end of all, when all settings are fine, press button Apply to save the resource. It will now be ready for use, that is, this resource can be opened.
Some examples are given below to help you quickly on the way.
Manually preparing content is not difficult. At the start of each verse, just insert the appropriate anchor, for example:
Then make the appropriate settings in the dialog for this resource to work. It's not difficult, only that it is a bit of work seeing there are so many verses.
To create the NET Bible as a local resource, download the HTML frames version from www.bible.org and unpack the files in some directory. Create a new resource. As the type choose "Based upon NetBible". Add all the files of the NET Bible that were unpacked above. Tick the books and the anchors as okay. Press OK to save this resource.
The Cambridge Paragraph Bible, written by F.H.A. Scrivener, including all the footnotes and cross references, can be found in the Libronix Digital Library System. In this example we are going to create Genesis from that book as a resource. To do that, do the following. In the Libronix Digital Library System, open the Cambridge Paragraph Bible written by Scrivener, and copy the book of Genesis to a word processor. This may have to be done in stages because when tried the last time, Libronix did not allow the whole book to be copied at once. Save it as a .htm page, for example gen.htm. Move that file to Linux. In Bibledit create a new resourse of type "Retrieve a different URL for each verse". Call this resource "Cambridge Paragraph Bible". Add the file "gen.htm" to the resource. For the home page, enter whatever you wish that would make a nice home page. This could be, for example, a title page, or a page made by yourself that has links to all the books. Let's enter here "home.htm", provided that this file is made available. As the URL constructor enter ".htm#be_anc__" (without the quotes). Then enter some book names for the constructor. After pressing the Books button, enter "gen" for the book of Genesis (without the quotes). In the URL constructor above, this means that "" is replaced by "gen", so that file "gen.htm" is loaded when we go to Genesis. After this is done anchors for each verse need to be inserted in the file gen.htm. Press button "Write anchors" to do that. In that dialog set the type to "Chapter starts at a pattern, verse 1 starts at chapter, verse starts at a pattern". Open the file gen.htm for conversion. As chapter prefix enter ">", as the chapter number choose "I, II, III", and as the suffix enter ". <" (all without the quotes). As the verse prefix enter ">" and as the suffix enter "<" (without the quotes again). The verse number can be left at "1, 2, 3". Then press the "Write" button. After done, press OK. Back in the Resource Editor, tick "Books are okay" and "Anchors are there", and press OK. The resource is now ready for use.
Projects from Bibledit can be made into a resource with little effort. Export a couple of books to OpenDocument. Then open these in OpenOffice, and save them as HTML Document. Then create a new resource, view at the anchors that Bibledit placed for you, make the appropriate settings, and ready it is.
The USFM can be imported into a Bibledit project. From the Bibledit project resources can be made, as described above.
There is a transcript of a conversation between two people how they managed to create a resource out of data exported from TW/folio. This transcript is given in full and might help you gain understanding in how to create the same or a similar resource.
Bibledit provides a tool that makes a web page fit as a Resource.
The tool will add the appropriate anchors at the appropriate locations in that web page.
Various buttons and settings will enable the user to write the right anchors at the right places. These are described below.
Press the "Type" button to select what type of resource conversion is to be done.
Pressing button "Open" allows the user to open a file for conversion.
Viewing the file is important in order to find out what type of web page it is and how the anchors should be placed. If the "View" button is pressed, the web page opens in a web browser. Modern web browsers also allow the user to view the source of the page. This comes in helpful because the resource converter works with the raw text.
To allow the resource converter to find the places where a chapter starts, a mechanism has been provided that takes a chapter pattern to look for. If that particular pattern is found, the resource converter will place the anchor there. Here is an example of a chapter starting in raw html code:
II. Thus the heavens and the earth were finished, and ... and so on.
This raw html code gives the beginning of chapter two of the book of Genesis. It can be seen in this raw code that chapter two can be found by looking for ">II. <". Chapter three would be found as ">III. <". And so on. It can be seen that the prefix is ">", that the chapter uses Roman numerals, and that the suffix is ". <". So then, if these values are entered in the chapter detection pattern, things will work out fine.
The verse detection works similar to the chapter detection system described above.
If the "Write" button is pressed, then any old anchors ever added by Bibledit will be removed from the file that was opened, new anchors will be written using the chapter and verse detection mechanisms, and the file will be written to disk.
Visit the web page for Bibledit-Desktop at bibleditdesktop.org