-
Notifications
You must be signed in to change notification settings - Fork 6
Tutorials
To create a new project, choose Menu / File / Project / New. The Project Properties dialog opens.
Type the name of the project, optionally make settings and add some books, and click OK.
Adding books to the project can be done in two ways:
-
Add templates for the books through menu File - Project - Properties. The templates contain some markers, chapter and verse numbers, and in some cases a bit of example text.
-
Add existing books by importing them into the project.
In menu File - Project - Properties, books can be removed.
In the editor, just press Ctrl+O, or do it through menu File - Project - Open, and you'll be presented with a list of projects that can be opened. Click the project that you wish to open, or otherwise type the first few characters of the name of that project, and then press Enter.
A project can be closed with Ctrl+W, or via the menu, File - Project - Close.
A project can be copied in its entirety to a new name. See menu File - Project - Copy to. This new name will then be an exactly copy of it and can from now on be dealt with as all other projects.
Through menu File - Project - Delete a project can be deleted. The project that is currently open is not shown in the list of projects that can be deleted. Non-editable projects are not shown either.
Printing a project goes via menu File - Print, then to select "Project".
In that dialog you've the option to include or exclude certain books, and to set which portion of any book will be printed. Remove the tick to exclude it. Focus it, and then press the appropriate button to select the portion to be printed.
Once printed it will open in a pdf viewer, and you can print the whole project or part of it from there.
See also Printing.
A whole project can be compared to another one. Any differences are highlighted.
Words that have been added are printed in bold. Words removed will appear stroked out.
If only the changes are printed, then the references, that have a change, will be loaded in the Reference Area for easy review.
See the File menu, then menu Print, then Parallel Bible.
The so called "Parallel Bible" contains parallel versions for only one book, and is intended for producing worksheets for use during translations sessions. The members of the team each get a pile of sheets with all relevant versions printed in parallel on it, verse by verse. Without these sheets each member might have a lot of Bibles strewn about him on the desk, but with these sheets things get more compact. And there will still be Bibles enough on the desk, as many Bibles are not available in electronic format, and hence cannot be printed on the worksheets.
Commentaries can also be printed on the worksheets, provided they are available as projects in Bibledit.
The Parallel Bible will be printed with the currently opened project at the top, and it will print the book that is currently opened. Therefore, to change the first project on the sheets, just open another project, and for changing the book to be printed, just go to another book.
To add another project to your Parallel Bible, press the "Add project" button and select the project to be printed. Added projects can be removed with the Remove button.
Normally all parallel verses are kept together on one page for greater readability. Depending on the number of Bibles printed in parallel, this may leave a lot of whitespace at the bottom of the page. To save paper you can uncheck the option in the dialog, so that the parallel verses no longer are kept together and the paper is filled with text to the bottom.
You can set which portion of the text to print. There are two controls that influence this.
The "Change" button for the portion. This selects which portion to print.
The "Include verses 0" checkbox, whether to include the verses 0 from any of the chapters. Verse 0 is anything before verse 1.
At the end press button Ok to get the Bible in .pdf format.
Add a new chapter to a book by inserting the "c" USFM marker, or by choosing Insert - Chapter.
To remove a chapter from a book, choose Edit - Chapter number. In the dialog that comes up, choose "Delete the chapter" and press OK. The chapter that is currently visible will be deleted.
To change the number of a chapter, choose Edit - Chapter number. In the dialog that comes up, choose a new chapter number from the list or enter it manually, and then press OK.
See Backup.
See Changes.
##General
During the process of translation many notes will be made that related to the project.
Project notes are stored in a database, and are independent of any Bible text. That is, whichever project is opened or closed, the notes remain the same.
To make a new project note press Ctrl+N.
To edit an existing project note click on the blue reference(s) for that note.
When creating a new note or editing an existing one, the project notes window splits up into two so as to make space for a couple of controls.
Project notes can be deleted by clicking on the blue [delete] link.
Some keyboard shortcuts help while editing notes. An example will show how: The user edits the text of a project. To make a new note, he presses Ctrl+N. He types some text in the note. If he wishes to change to category of the note, he presses Alt+A, then Enter to open the list of categories, then he makes a selection with Up Arrow or Down Arrow and presses Enter to confirm the selection. If he wishes to add some references, he pressed Alt+R and types some references. Alt+O saves the note, and takes the user back to where he was editing the text. Ctrl-I puts the text in italics, Ctrl-B makes it bold, and Ctrl-U underlines it.
When a project note is being edited, the creator of the note can be retrieved through menu View / More information on current note. Other information about this note is visible there as well, like the date it was created, and when it was edited.
Each note falls into a category. The various categories and the default category can be set in the preferences.
Menu / Edit / Find in Project notes (Alt+E, N) allows to do Simple searches in the Project notes.
This tool searches exacty (except case sensitive) for the sequence of characters entered into the "Search for" box, punctuation marks and spaces included. Case sensitive can be switched on or off.
Project notes usually have one reference. This is the one for which the note was created. But additional references can be added as well.
These references are shown attached to each note.
There are two ways to get these notes into the references window.
-
Open a note to edit it. In the menu choose Edit - Get references from project note.
-
Click on the blue word [references] of a note.
As a result the references will be loaded in the references window. Once there they can be activated and the text belonging to that reference will appear in the text editor.
Many people have one project with the actual text, and a separate project for their project notes. There is a historical reason for doing so. This separate project may have checking questions, answers from native helpers, a history of different renderings, commentary support, notes following consultant checks, and so on.
It would be a lot of work to copy and paste these notes into the project notes one verse at a time.
The tool "Transfer text to project", under the Tools menu, helps you with this.
It transfers all text that is in the currently opened project into the project notes.
It takes a good while to do this.
If project notes need to overlap the chapter boundaries, the reference can be manually entered like, for example: Luke 2:2-3:3. Bibledit will divide this into two parts: Luke 2 verse 2 to the end of the chapter, and Luke 3 verse 1 to 3.
The settings for which notes to show and how are in the View menu.
Project notes can be exported into some formats.
-
Bibledit Notes version 3. This is the format used by the current version of Bibledit. In other words, notes exported through this option can be imported in Bibledit.
-
ScriptureNotes version 2.0. Notes exported in this format can be imported by Translation Notes Editor 6.0.
To see how these formats looks, just export some text and open the exported text in a text editor.
The notes that you make on your computer can be shared with other members of the team. These notes you make will then also be available to the members of the team, and the notes made by any member of the team will also become available to you.
You can set the sharing up through the Remote Repository Assistant. Normally this assistant sets up project sharing. But it can also set up notes sharing. Just make the appropriate selection at the start of the assistant. It will be good to read the entire section about Collaboration if you need to set it up, since it fully explains the technical details.
Notes are stored in flat files, but selected from an index. If the index for some reason gets corrupted or out of sync, then you can recreate it by either deleting the index manually from directory ~/.bibledit/notes and then restarting Bibledit, or by setting the sharing up again through the remote repository assistant.
Menu File - Project notes - Send / Receive to a manual sync of your notes with the remote repository. Normally the sync is done automatically, though, by default it is done every hour, but you can change this in the remote repository assistant.
A Bible note is a note that goes in the Biblical text. It can be a footnote, or a cross reference, or an endnote.
Bible notes can be inserted manually by applying an appropriate note style. For example, if the "f Footnote" style is applied, then a window comes up allowing insertion of this footnote. The same applies to endnotes and crossreferences.
Bible notes are marked by a asterisk or character in the editor. Its text is visible at the bottom of it.
The asterisk corresponds to no caller (-), the characters to automatic callers or a given caller in the text.
Removing a note works as you would remove any text.
Notes can be cut and paste in a text (which is only useful in the same verse, if a verse-reference (\fr or \xo) is included.
While editing a note, pressing Page Up takes you back to the main body of text, to the place where the footnote starts.
If a project is printed, it will show the footnotes, endnotes, and crossreferences. Printing a list of references does not.
Footnotes and crossreferences normally appear at the bottom of the page, inside the column they belong to.
Endnotes normally are printed at the end of all other text. This can be changed in the stylesheet. Edit the style for \fe to change that. The other options are to print them at the end of each book, or upon encountering a certain marker in the text.
Placing endnotes upon encountering a certain marker is the most flexible option. It allows endnotes to be placed exactly where you want them. If this option is switched on, it normally places them where marker \zendnotes is found in the text. You can insert the \zendnotes anywhere, and notes collected thus far will be dumped there. The \zendnotes marker can be repeated as often as you wish. The \zendnotes marker needs to be typed by hand because it is not in the stylesheet.
A Bible note has a caller. The style of the caller can be set in the markers, see USFM under marker \f. For crossreferences set it under marker \x.
A "+" prints a caller with automatic numbering, a "-" prints no caller at all, and any other character prints that character as a caller.
The automatic numbering can be influenced in the stylesheet, under marker f for footnotes and under marker x for crossreferences. The numbering 1, 2, 3 ... should be clear, and the numbering a, b, c ... follows the alphabet, and after reaching the z it starts all over again. A user defined numbering sequence can be given too. When for example §†* is given there, the numbering goes like §, †, *, §, †, *, and so forth. Any sequence of characters can be used.
Optionally the automatic numbering can be restarted every chapter or book.
The automatic numbering of endnotes is restarted whenever the notes are printed, either at the end of the book, the end of everything, or upon encountering a certain marker. See the style \fe to set this.
For a footnote, the \ft style has a full paragraph setting in the stylesheet. Here you can set how the normal footnote paragraph is going to look. For a crossreference, set the style under marker \xt.
For a new paragraph in the footnote, the style can be set under the \fp marker.
Bibledit can print things like a list of references along with the text, or the whole project, or part of the project, and so on.
Printing is done this way: Bibledit generates a .pdf file, and then opens this file in a pdf viewer. From there it can be printed.
The font to be used can be set under menu View / Font & Colour / Text.
Additional fonts could be looked for by searching the internet for "Free Unicode fonts" or at http://scripts.sil.org.
In the dialog where the font can be selected, there is also a setting for the line height, in percentages. Normally it is on 100%. Setting it to e.g. 200% gives the line a double height. This would for example allow for text and notes to be written between the lines on worksheets.
These are footnotes, endnotes, and crossreferences. Location of .pdf files
The .pdf file for printing a project usually is temporary directory/document.pdf.
Normally text is laid out in two columns. The stylesheet editor allows the "span columns" property to be set. This means that a certain piece of content spans the two columns. Biblical content honours this setting, but content from the Front Matter and the Back Matter is laid out in one column.
Normally Bibledit prints all the books one after the other, without starting them on a new page. This behaviour is implemented so that normally not too much paper is used. Bibledit can be set to print each new book on a new page, or, going one step further, to have each book start on an odd page. Settings for this are in the stylesheet, under the \id marker.
Some styles have the "print" property in the stylesheet editor. If "print" is unticked, then this style won't be printed. This comes in useful when there is some data in the text that you don't want to print this time. Footnotes, for example. The quickest way of doing this is to make two stylesheets. One full stylesheet that prints everything. And one adapted stylesheet that doesn't print footnotes. Just opening another stylesheet in the editor, and printing, makes it work.
Normally words are not hyphenated. But if a word does not look well on the printout, and hyphenation is needed, the user can insert a soft hyphen in that word. The "Insert" menu caters for that.
Bibledit uses an internal engine to lay the text out on the pages. Under normal circumstances the commands that are sent to that engine during printing remain invisible. But there is a setting to make these commands visible, to review or edit them. The setting is under menu Preferences / Printing, tab "Formatter".
Bibledit can also make use of the ptx2pdf macros together with the XeTeX typesetter. More information is provided by UBS. If you have printed something through the ptx2pdf macros, then the files that control this printout are available in /tmp/bibledit/xetex. If you run "xetex document.tex" within that directory, you can do the typesetting again. You can modify the control files there, so as to fine-tune it to what you need. To do complex non-Roman scripts like e.g., Farsi is, you will need the latest version of XeTeX. The one that gets install with the current version of Ubuntu (9.10) may not be good enough. You can pull the most up to date version from the SIL repo. (deb http://packages.sil.org/ubuntu karmic main). With XeTeX you can also print numerals in a different script. See the Questions for more information.
See also:
Questions
Print portion
Bibledit can assist you in planning the work.
There are three places in the Bibledit menu that are relevant to planning.
-
Preferences / Planning. This is for setting it up.
-
Edit / Planning. This is for editing the planning and status.
-
View / Planning. This shows the planning and reports on progress made.
How it works is going to be explained below by an example.
Go to menu Preferences / Planning. The Planning Setup dialog shows.
The first thing to do in that dialog is to indicate when the project was started.
After that you can enter the tasks that the project consists of. Let's add two tasks, "First draft", and "Final draft".
The last thing to do is to indicate how much time each task takes to complete one chapter. Let's enter three days per chapter for the first draft, and two days per chapter for the final draft.
This sets you up for making a planning and for reporting the progress.
Once you have set up everything, the next thing to do is to update the progress of the work. This can be done through menu Edit / Planning. If this is chosen, a dialog, called "Planning Edit" shows.
You can edit the project's status. This means that you can tick off which bits of work have been completed.
For making a planning for the shorter term, you can enter which task are supposed to be done.
In order to view the status report, choose View / Planning. This should give a report of the progress you make, and the planning.
Through menu Edit the Find menu can be opened. The same can be done through the keyboard shortcut Ctrl+F.
A list of hits will show in the references window.
Menu / Edit / Find (Ctrl+F) searches exacty (except case sensitive) for the sequence of characters entered into the Search for box, punctuation marks and spaces included. Case sensitive can be switched on or off. Searching can be limited to the current book.
Example: Searching for "ue. t" (without the quotation marks) shows all the references with the words: true. The.
Note that for the text to actually display, you have to hit one of the search results.
Menu / Edit / Find (Ctrl+F, Ctrl+F) allows more complex searches than the Basic Find:
-
Search box to enter text.
-
Case sensitive: on or off.
-
Search in curent book only: this limits searching to the current book.
-
Interprete * and ? as wildcards: on or off.
-
Match start of word: on or off.
-
Match end of word: on or off.
-
Select books: some books (all), for details see Select books.
-
Which area of the text to search in.
-
What to do with the search results. This gives the choice how the results will show up in the references window, see Loading results below.
There are two wildcards. The ? and the *. The ? means "any single character". If one were to search for "p?t", and ticks the option for wildcards, then the search will hit results like "pit" and "put". The * works similar, but means "zero or more characters".
Searches can be done in certain areas of the text. When searching in the raw USFM text, then one searches in the text as it is stored, e.g. one can search for markers too, like \add. When searching in all the text except the USFM codes, one searches in the text as it will appear on the paper when printed. This means that searching for markers is not possible, as these will be hidden on the paper. When searching in certain categories, one can limit searches to, let's say, only the introductions, or only the verse text, or only headings and identifiers, and so forth.
Once an advanced or BibleTime search has been done, one can decide how they interact with what is already in the references window.
-
The search results can simply be loaded in the references window, and so replace anything that is already there.
-
Or the search results can be added to the references already there.
-
Or they can be removed from the references already loaded.
-
Sharing the search results with what is already in the references window means that only the references that are the same will be kept in the references window, and the other ones will be discarded.
In the case that in a Special Find the option: 'Share them with the ones already in the references window' is chosen, and this special find with this option is repeated several times, several groups of characters can be highlighted in the text editor (as a result from the different searches) when a reference is activated in the references window.
Menu / Edit / Find and Replace (Ctrl+R) searches for and replaces text. It goes like this:
Press Ctrl+R to start the find & replace. Enter the word to search for, and the word to replace it with. Optionally make settings like case sensitive, searching in current book and/ or chapter, or select the books to operate on. Press Find to start the operation.
A new dialog will open. It shows the verse to be affected, e.g. Esther 6:5. It also shows the original text as it is before changing. This is in the top half of the dialog. Below that it shows the suggested text as it would be after change. If you want to make changes to the suggested replacement, then you can edit this in the lower half of the dialog.
Once you are satisfied that the change is going to be the one that you want, then you can press button Yes. Press No if you don't want to change this verse. Or press Cancel to stop changing. If you press button All, it would change this verse and all following relevant verses. Be careful with this option. It could change instances that you may not have wanted to change.
See Project Notes for more information.
With Bibledit several users can work on one Bible at the same time.
The users collaborate through the network or a USB drive.
Once everything has been set up, the user needs to Send/Receive the data, and the rest goes automatic. The user does not notice the mechanics of the collaboration, it all happens under the hood.
There is a variety of methods for collaboration. The user who will set it all up needs to have sufficient knowledge of information technology.
Bibledit stores all data locally. When collaboration is enabled, it also connects to a central repository. Through that repository the data gets shared between the users.
Under the hood, Bibledit uses Git for collaboration. Git is a content manager. The user does not notice that Git is used. He does not operate it. Bibledit does it all for him. The only thing that the user notices is that the changes introduced by the other users appear on his screen too.
There is a variety of repositories that can be used. Each of them has it own use, advantages and disadvantages. First of all there is the repository that resides on a file system. A USB flash drive can be used in this case. This flash drive can be physically moved from one user to the other, and so on, updating each user, and getting updated by each user. Secondly there is the repository that resides on the network. For internal networks a simple open network repository can be used. Whosoever knows where the repository resides can write to it. For public networks such as the internet a secure network repository would be recommended. This type of repository is locked down. Only those who have the keys to such a repository, or a username and password, can write to it.
The central part to collaboration is the repository. The system administrator will have set the repository up, will have initialized it, and issued its URL. If the repository is a secure one, set up the secure shell keys to access it.
The repository is now ready for use. It remains to add users who make use of this repository and share their data through it.
In this tutorial it will be user Jim. In Bibledit, Jim opens the project he wishes to share with others, or he creates a new project. He goes to menu Preferences / Remote repository. and sets everything up. Jim can now work on Bibledit as before, and his data will be automatically updated in the repository.
The repository is the heart or the central part of the collaboration system. In this tutorial you will learn how to set up a repository.
There are several types of repositories. See the introduction. Each of them will be described separately in this tutorial.
Depending on what system you use, you can either set up a USB flash drive, or set up an open network repository, or a secure network repository.
Now we come to the purpose of everything, which is working together on one project.
This collaboration is very simple: Just work on your data as you did before. At times when you´d like to share your work with others, or when you'd like to see work done by others, choose menu File / Project / Send-Receive. Bibledit cares for everything, and everything will be updated and shared automatically.
Suppose that two or more people collaborate on one project. One of them is a bad typist. He makes many errors. The bad typist has the potential the harm or destroy the project's data. If he makes serious mistakes in his own data, then the collaboration mechanism will propage his mistakes to the other members of the team. This is not a desirable situation.
Bibledit has a solution for this situation. You can use two mechanisms of Bibledit simultaneously.
-
Collaboration through the network or the USB stick.
-
Merging changes.
This is how to do it:
-
The experienced person has project "master" that has the master copy of the Bible. Collaboration of the master project is switched off so that no changes can enter that project by mistake.
-
The experienced person has project "messy" that initially is a copy of the master project. Collaboration is switched on.
-
The unexperienced typist has project "messy" too, with collaboration switched on.
-
The unexperienced typist makes changes in project "messy", and through collaboration these changes go into project "messy" of the experienced typist too. This all goes automatic.
-
Once in a while the experienced person goes to the Merge tool. He opens project "master" and project "messy", reviews the changes as proposed in project "messy", makes any edits he likes, takes out any mistakes he does not like, and then finally merges the changes from "messy" into "master". This is done chapter by chapter. Once the merge is done, project "master" and "messy" are identical again in that particular chapter.
-
Any changes entered or not entered propagate to the unexperienced typist again through the collaboration. If the unexperienced typist made a big mess in a certain chapter, through the collaboration this mess is cleared up again on his computer.
-
The collaboration system can conveniently be used for automatic backup.
-
Collaboration of two projects on the same computer is possible if those projects have the same ancestor, that is, one is created by importing all the Biblebooks exported of the other one. This can be helpful for demo purposes and to test and learn to use this tool if only one computer is available.
-
Sending and receiving the data of your Bible will happen automatically at intervals. Bibledit will receive any changes from the repository, and then send its own changes to that repository. To manually send and receive your Bible, use menu File / Send / receive.
-
Using collaboration with merging data has advantages in the following situation: Think of the situation that a bad typist is out in the bush, and comes to town with his stick, and has little time for the master person to merge while he waits. So just plugging in he stick, a quick automatic merge, and away he goes again. Then if the master person has some time in the days or weeks following, he can then carefully go through the messy project, and merge it with the master project, taking his time for it, and doing an accurate job.
-
There is not much need to maintain the git repository since Bibledit does run maintenance on it at regular times. But if you really like to compress the repository well, you can run "git gc --aggressive" in the repository. Note that Bibledit already runs "git gc" at regular times.
-
If two or more users were to work on the same chapter at the same time, this would pose a problem for Bibledit. This type of collaboration is not supported. People should work on different chapters, or on the same chapters, but not simultaneously. Then the merging of the changes will work well.
###Introduction
Under normal circumstances, the users collaborate in one project. They send and receive their changes regularly. At times it may occur that two users make changes in the same chapter of text, or in the same project notes. After doing Send/Receive, a conflict may arise. Bibledit-Desktop does not know which of the two edits to take, either the edit of the first user or the edit of the second user. This is called a conflict. For Bible text, Bibledit-Desktop tries to resolve this conflict automatically, keeping one edit, and throwing away the other. But for project notes, this does not always work. Manual intervention is required to resolve this conflict.The rest of this page describes how to notice that a conflict has occurred in a project note, and how to manually resolve it.
###Symptoms The first symptom of a conflict is that the users get the impression that the collaboration system has stopped to work properly. The users make their edits. But these edits and changes do not propagate to the other users.
If a conflict is suspected, then it is good to find out about it, whether this is indeed the case. A simple way of finding out is this:
- Shut down Bibledit, and start it again. This clears the system log.
- Send and receive the project notes. Do this through menu File / Project notes / Send-Receive.
- View the system log to see whether a conflict has occurred. Do this through menu Help / System log.
If there is a conflict, then the log shows something along those lines:
Auto-merging 78294313CONFLICT (content): Merge conflict in 78294313
Automatic merge failed; fix conflicts and then commit the result.
The log shows that there is a conflict. Notice the number: 78294313. This is the number of the project note that has the conflict.
There are several ways to resolve the conflict. A simple one is described below. It just throws away the edits that one user made, and takes the edits that the other users made. In other words, it takes the version that is already on the server, in the remote repository.The user who has the conflict does the following:Opens a terminal, and types the following series of commands, one by one, and presses Enter after each command:
cd
cd .bibledit
cd notes
cd data
git checkout --theirs 78294313
Notice that the number of the note that has the conflict is 78294313. This only works in this example. Your note number will be different. The note number was found above.
Close the terminal.
Start doing the sending and receiving in Bibledit-Desktop as usual. Collaboration should work again. You may view the system log, as described above, to ascertain that everything works well again.
Most of this tutorial applies to Linux but some things may be slightly different
Lesson 1 - Open, Close, and Help
To start using Bibledit: Click Start->All Programs->Bibledit->Bibledit
You will see the Bibledit Menu window open up
To get help using Bibledit: Click Help->Contents
The help webpage will open: Click the Tasks or the Tools link
Bibledit help has 2 main sections Tasks and Tools
The Tasks section discusses general Bibledit tasks that a user will typically want to do.
The Tools section describes each Bibedit menu item.
For example, if I click Tasks and then Import then the help page shows a variety of topics about importing texts and where to get some standard Bible to import. If I click Tools and then Import then the help page shows a description of the Import text dialog that appears when you choose the File->Project->Import menu item.
To close Bibledit click the X in the upper right corner of the Menu window
Lesson 2 - New Project, templates, navigation and goto
Open Bibledit.
Click File->Project->New: This will open the New Project Dialog
Choose Books:
Click OK: This will create the new project
The book of Matthew will open in a window below the menu window.
To go to a different chapter, choose the chapter number from the Menu window.
The fastest way to jump to a new reference in a different book is to use the Goto command. Press CTRL+G: You will see the Goto reference dialog box.
Practice typing in verses and jumping to a new verse and typing some more.
To close a project simply close the text window. A project is automatically saved as you work on it.
To open a project click File->Project->Open and choose the project you want to open
Printing
To print a project in Bibledit click File->Print
Lesson 3 - Editing (styles) /searching/footnotes
Styles are used to format text in Bibledit.
To open the styles window in Bibledit click File->Styles->Open
Select the text that you want the style to be applied to and then double click the style name
To add a footnote place the cursor at the end of the word to be footnoted and double click the footnote style
Click ok
Type the note after the footnote number
To delete a footnote, delete the footnote number from the Bible text.
To search go to Edit->Find or CTRL+F
Type in the term you want to search for.
The references window will open with a list of references where that word occurs. Double click the reference to jump to that verse.
Lesson 4 Multi views/project notes/import
To open a second project, go to File->Project open and choose another project to open
When 2 projects are open they both move to the same reference.
.A project note is a note about the current passage. These can be reviewed later for checking
To create a project note press CTRL+N
The project notes window will open.
Type the note, choose a category and click ok
To review all the project notes click View->Project notes
Choose the option: “any verse�,
Click OK
Lesson 5 checking/verse/keyterm/Export/Quotation marks
To check if the chapter and verse numbers are correct click Check->Chapters and Verses. A list of missing references will show in the references window
Keyterm check
To check keyterms click Check->Key terms. This will show the keyterms window
Select a keyterm
Double click the correct word in the red verses
Export for back translation
File->Project->Export->Unified Standard Format markers
Click your username in the left column, choose My Documents->Adapt It Unicode Work->Export. Then click Open
Quotation marks
Use < and > for single opening and closing quotes and << and >> for double opening and closing quotes. Bibledit will automatically replace these symbols with curved quotation marks when the text is printed or exported.
At times there may be a need to branch off a translation project, so that two translation projects exists, the main one and the branch. Various people then can work on the branch. After some changes have been made, there may be a need to merge the branched project back into the main project.
Some teams have a main project and an edited project. The main project is maintained by one person. All the members of the team work on the edited project. At times the person that maintains the main project would wish to merge the data of the edited project into the main one.
Bibledit provides the "Merge" tool for the above scenarios and for any other scenario the user can use it for.
In order for data of two projects to be merged succesfully, both of the projects need to have what is called a common ancestor. That means that going back in the history of the projects, there must be a moment in time that the data of the projects was the same. Usually this is accomplished by:
-
Making a copy of the main project. The main project remains as it is, and the copy of that project becomes the "edited" project.
-
Exporting a file of one project and importing it into the other one.
So, the setup is simple. Just take one project, or export from one project and import it into the other one. The data of these two projects is now capable to be merged after some changes have been made in the text.
So, how does the merge work?
The first step is to open two projects in the same window, so that both of these projects are visible at the same time.
Then open the merge window.
In the merge window, it asks for the master project, and the edited project. If both of these are selected, then the text of the projects will show up in the window.
Any changes are visible in that window. Additions are marked in bold and deletions in strike-through. It is important to know at this stage that any footnotes, endnotes and crossreferences are not marked this way.
If the editor goes to another chapter, the changes will be reloaded.
There are also two buttons in the merge window, one labelled "Previous", and one "Next". These buttons, if clicked, will look for the next or previous chapter that has changes.
Then there is the "Merge" button. Clicking this button starts the merge procedure.
It shows various possible actions to take. These are described below.
Once the merge operation starts it looks through the history of both projects to find the common ancestor for this chapter. It then tries the merge operation. If all went fine, then that's it: The job has been done.
Here follows a bit of a description of the merge process. It is not so that the last change that was made in any of the projects will be taken. It works slightly different. There is the master project, and the edited project. If the user merges these both, then the tool is going to look back in the history of all changes ever made in that chapter, till it finds the point that this particular chapter is the same in both master and edited project. It then looks at the changes made in the master project, and tries to keep these. It also looks at the changes made in the edited project, and tries to keep these too. It then puts both of these changes in a new chapter, and finally saves that chapter in both master and edited project, so that we can truly say that a merge has occurred. The goal is that this chapter is going to be merged, and will after merge be the same in both projects.
If all did not go well, then that means that there were changes in both of the projects that would affect one and the same place. Bibledit does not know in such a case which of the two changes is the correct one, and needs the user to select the correct text. A window will then open showing one or more pairs of buttons. Each button has a label showing the possible text. Clicking on the one button inserts the one text, and clicking the other button inserts the other text. If you click a button, it means that you approve of the text that is in its label. When all places have been corrected, then the OK button at the bottom of the window becomes active. Clicking that saves the text, and ends the merge operation.
Merge chapter of edited project and master project, and approve of each change as compared to master project
This is an addition to the simple merge procedure as descibed above. The extra thing here is that changes are not automatically accepted. Each change must be approved of manually. A window becomes visible that allows to approve of change. If a button has a "+", then it means there is an addition to the master project. And if it has a "-", then that means that something was deleted from the master project. Approval of a change is made by just clicking the button. Once one or more changes have been approved, if the user clicks the "Save" button, then the changes will be saved in the master project. Change won't be saved to the edited project. If that is desired, as it usually is, then the merge operation should be repeated, with the option chosen to copy the chapter from the master project to the edited project.
This copies a chapter from the master project to the edited project. The chapter to be copied is the one that is visible in the editor.
This copies everything from the master project to the edited project. Useful for ensuring that the edited project is the same as the master.
Styles mark the parts of discourse that a block of text belongs to, and secondly determine how the text will look when printed.
Styles are given in the text with markers, or more fully Unified Standard Format Markers, shortened USFM.
Styles are bundled in a stylesheet.
Each project has one stylesheet attached.
This will be discussed later on this page.
If you know which category the style is in, expand that category and locate the style.
Else expand all categories through function Expand all, then focus the Styles Area, and start typing the first couple of letters of the style marker (not the style name). The cursor will move to the style you look for. Pressing the up arrow or down arrow will take you to the previous or next category that starts with these letters.
Do it through function Insert.
The style will be inserted at the cursor postion.
There are styles that have a begin- and end marker, and if a word has been selected, and such a style is chosen, the selected word will be put in that style.
Styles have been divided into categories for better overview. See USFM.
The categories can be expanded or collapsed.
There is a category called "Other styles". Any styles Bibledit does not know where to put go into this category. If somebody defines his own styles, these styles will go into this category.
To start editing a style, check the Edit mode.
When there is a small tick at the left of the Edit mode, like so: √ Edit mode, then the mode is checked, else it is unchecked.
Once the Edit mode is on you can start using the editing functions in the menu.
Do it through function New.
If the style is known in Bibledit's templates, it will fill all the values in for you. The values can be edited.
Else, after you've created the new style, edit the style.
Through function Properties.
This will bring up a window where you can edit this style.
The style determines how the text affected by it will look once printed.
All styles should speak for themselves.
Notes:
-
Where there is the choice to span two columns, this refers to the two-column layout normally used in a Bible. A major header normally spans these two columns, but a minor header does not.
-
A paragraph can be a main title, a subtitle, a section heading, a normal paragraph, and so on. At present these settings are used during exporting a project to SWORD.
In the Styles Area, select the style or the styles you wish to delete, and choose the Delete function.
When a style has been inserted in the text, it will then also be displayed in the category "Recently Used", and will be accessible from there too. A maximum of 30 styles will be displayed. The styles are sorted on usage count, and the most used styles appear at the top of the list.
When a style has been inserted in the text, it will then also be displayed in the category "Recently Used", and will be accessible from there too.
These recently used styles are attached to the stylesheet. This implies that if another stylesheet is opened, the recently used styles may change.
These styles can be deleted. Just select the style or styles you wish to delete, and choose the Delete function. Or select the category itself, and delete it.
If any style is deleted, and this style happens to be in the recently used category, it will be removed from there also.
A stylesheet can be opened through function Stylesheet - Switch.
The new stylesheet will be attached to the project that is open.
Choose function Stylesheet - New. More information is available.
Choose function Stylesheet - Rename.
Choose function Stylesheet - Delete. A list of available stylesheets comes up. The one currently opened is not shown so that it cannot be deleted by accident. Select a stylesheet and press Ok. The selected stylesheet will be deleted.
That's done through function Stylesheet - Export or Stylesheet - Import.
A stylesheet is exported as a database. This database contains all the individual styles that are in that stylesheet. It asks for a filename, adds the right extension to it, and then saves the file, for example, as "Standard.sql5".
This same database can be imported in Bibledit.
Thus stylesheets can be shared among users.
Functions that work with styles are used in various ways.
To focus the Stylesheet window, do any of the following:
-
Choose menu File / Styles.
-
Or click in the Stylesheet window.
-
Or press Shift+F5 once or more until the Stylesheet window has focus.
-
Or press Ctrl+S.
The first thing to do when working with styles is to focus the Stylesheet window.
If the categories are still collapsed you can expand them. Focus the category and expand it.
Then you can use the up or down arrows to move the cursor to a particular style, or click on a style.
-
Then choose menu File / Styles, and then one of the functions.
-
Or right-click in the Stylesheet window and choose one of the functions from the Styles pop-up menu.
-
Or press Shift+F10 to open the Styles pop-up menu, and choose one of the functions.
Double-click a style to insert it in the text, or when the Edit mode is on, to edit this style.
If the focus is on a style you can press Enter to insert that style.
You can press Insert to create a new style, and Delete to remove a style, provided the Edit mode is on.
The first thing to do when working with stylesheets is to open the Stylesheet submenu. To do this:
-
Choose menu File / Styles / Stylesheets, and then one of the functions.
-
Or right-click in the Stylesheet window and choose function Stylesheets, and then one of the functions from the Stylesheets submenu.
-
Or in the Stylesheet window press Shift+F10 to open the Styles pop-up menu, choose function Stylesheets and choose one of the functions in that submenu.
Visit the web page for Bibledit-Desktop at bibleditdesktop.org