# Program Operation

&bibletime; is mainly operated from the Module Tree (this tree is called the "Main Index"). The second important place to work with &bibletime; is the MDI area (MDI = Multiple Document Interface).

## Main Index

This is the pane on the left side of the &bibletime; window. It contains the tree of installed documents (Sword Modules), as well as any bookmarks you enter.

Module Tree

### Selecting a document to view

To select a document, click with the left mouse button on the desired document group (Bibles, Commentaries, Lexicons, Books, Devotionals or Glossaries) to display the contents of a document group, click with the right mouse button on the icon for the desired group. To open a document, click on it's icon.

Document Selection

Drag & Drop Works Here

A document can be opened from an already opened document. Simply click with the left mouse button on the verse number (pointer changes to hand) and drag it to the module list. Drop it on the name of the module you want to open, and it will open that module to the verse you dragged over. If you drag a verse number to an already open module, it will automatically jump that module to the location of the verse that was dragged over. This works for Bibles and Commentaries only.

There are two other functions accessible through clicking with the right mouse button on the document name. "About This Module" opens a window with information about copyright and other pertinent things about the selected document. "Unlock This Module" opens a small dialog for encrypted documents. This allows those with the key to enter it to decrypt the document and make it human-readable. Crosswire Bible Society must encrypt modules unless either the copyright holder provides permission for distribution as a sword module, or the text has passed into the public domain (copyright has expired). See information on locked modules on the Crosswire Bible Society web site.

### Accessing the search dialog

You can search in a module by clicking with the right mouse button on the module name in the module list and selecting "Search in module(s)". By pressing shift and clicking on other module names you can select more than one. Then follow the same procedure to open the search dialog. You will be searching in all of these documents. A complete description of the operation of the search features can be found here.

Bookmark Selection

### Accessing bookmark functions

Drag & Drop Works Here

Click with the right mouse button on the bookmark group of the module tree window and select "Create new folder" to create a new bookmark sub folder. You can use normal drag 'n' drop functions to drag verse numbers from search dialog results to the bookmark folder, and to rearrange bookmarks between folders. There is an import/export function for bookmarks also. From the right-mouse-button menu, select "Export bookmarks". This will bring up a dialog box for you to save the bookmark collection. They can be shared with other &bibletime; users, archived, etc. They can be imported in the same way. You can also click with the right mouse button to change folder names and bookmark descriptions, and delete folders and bookmarks. Bookmark Selection

## Multiple Document Interface (MDI) Window

This is where the opened documents are displayed. Documents are displayed in "Display Windows", that are specific to the four types of documents. Crosswire Bible Society may release other document types for sword in the future. When they are released, &bibletime; will support them as well.

### Controlling Open Documents

Document Windows can be controlled and manipulated with normal &kde; window/title bar functions. In addition to this, you can tile and cascade open Document Windows. Use the appropriate tool bar buttons, or menu functions under "Window" in the main menubar. Document Windows can be set to automatically cascade or tile also.

### Navigating in Open Documents

Navigation within a document is accomplished with the Document Key Control Menu, and the scroll bar.

To move to a specific location use the Document Key Control.

To move within a section of a document use the scroll bar.

For Bible texts the index key is Book - Chapter - Verse

For commentaries the index key is Book - Chapter - Verse

For lexicons the index key is Keyword

Drag & Drop Works Here; if you drag a verse from one open document or a bookmark and drop it on another the second document will jump from it's current location to the location of the verse or bookmark dragged.

### Editing your own commentary

If the personal commentary is opened with a left mouse button it opens in read only mode. If you wish to make entries to the personal commentary, right mouse button on the personal commentary brings up the choice of the plane text or the HTML editors.

If the editor does not save an entry, please check that you have permission to write to the personal commentary.

The pencil icon is shown for the commentary editor

. Enter your notes

The personal commentary editors are provided with a search key and save button. The HTML editor is also provided with the basic functions font name, size, color, italicize, underline and some paragraph formating possibilities. As with all good modern editors What You See Is What You Get.

To delete notes for a selected verse, click the delete verse button Delete Verse Symbol .

The personal commentary is a sword module. If you do not find it in the main index, get it from the Crosswire Bible Society.

If you can not write to the personal commentary your permissions for the personal commentary module are wrong. Reset the permissions to allow your user to write to it.

Drag & Drop Works Here, just like other commentaries and Bible texts.

## Searching in Documents

Portions of the instructions for the use of GCC Regular Expression in Searching Documents is taken from the help files for the Microsoft Windows version of &sword;.

### Accessing search functions

You can search in a document by clicking with the right mouse button on the document name in the Main Index and selecting Search in module(s). By holding shift- or ctrl- and clicking on other module names you can select more than one. Then follow the same procedure to open the search dialog. You will be searching in all of these Documents.

### Using the Search Dialog

&bibletime; provides a well developed search facility based on GCC Regular Expression. It allows you to create almost any type of search you can imagine.

To access the search feature, click with the right mouse button in the Main Index now in the drop down select the magnifying glass. You can also customize &bibletime; to put the search icon in the toolbar if you would prefer.

#### The Options Tab - Setting up your search.

Use the options tab to set up your search.

Search Text Dialog Options Tab

##### Using the Choose Modules Button

At the top of the options tab you will find Choose Modules , with the already selected modules directly below. If you would like to search additional modules, click on Choose Modules and you will be offered a menu of all of the modules that can be searched. Select modules with a click in the checkbox, then click the Use Selected Modules button.

Choose Modules Dialog Box

##### Searched Text - what you want to find.

The text box labled Searched Text is where the phrase to be used as the search key is entered. This phrase may be one or more words, or partial words, (separate words, or partials, with a space), a phrase, or pattern (Regular Expression).

You can use the radio buttons select to perform the search using the search key in multiple word, exact search, or regular expression mode. A check box is provided to turn case sensitive search on or off.

Drag & Drop Works Here, you can drop verses and bookmarks into the text box. You can also copy and paste text into the text box.

##### Using the Search Text Case Sensitive checkbox

Click on the Case Sensitive check box to toggle case sensitivity on or off. If the box is marked a search will only find verse in which the found text also matches the case of the text in the input field. If the box is unmarked the search will match if the texts match but are different in case. To locate "LORD" but not "Lord" or "lord" mark the check box. To let "LORD" and "Lord" match "lord" leave the check box unmarked.

##### Using the Search Text Multiple Word (AND) Button

If Multiple Words (AND) radio button is marked the search will locate all lines (or verses) that have all the words, listed in the Input Field. The position and order of the words, in the line is not a factor. If all the words, are in a line, in any order, even separated by other words, the line will be included in the list of found lines. A search for "prove cause" will find Gen. 21:25, "And Abraham reproved Abimelech be cause of a well of water..." This is because a word that is part of another word is considered found if a word containing it is found.

##### Using the Search Text Multiple Word (OR) Button

If Multiple Words (OR) radio button is marked the search will locate all lines (or verses) that have any of the words, listed in the Input Field. A search for "cause" will find Genesis 21:11, "And the thing was very grievous in Abraham's sight because of his son."

##### Using the Exact Search

If the Exact radio button is marked the search will locate all lines (or verses) that contain what was entered in the input field, exactly as entered, including any spaces. The phrase found does not have to start or end at a word boundary. A search for "now how thou ought" will find 1 Timothy 3:1, "...that thou mayest know how thou oughtest to behave..."

##### Choose Search Scope Options

Define the Scope of your search by clicking on the Choose Scope button. You will be presented a list of predefined scopes.

- No Scope this turns off the search scope tab. The entire document is searched.

- Last Result The new search will only search within the verses found in the previous search.

- Gospels The new search will be performed within the range Matthew 1:1 - John 21:25

- History The new search will be performed within the range Joshua 1:1 - Esther 10:3;

If No Scope is checked and a search of the KJV Bible module is done for the name, Jesus, 939 matches will result. Then if Last Result is checked and another search is done for the title, Christ, 257 matches from the first 939 matches will remain. Then if Last Result remains checked and another search is done for the title, Lord, 106 matches from the 257 will remain. All the remaining 106 matches will have the name, Jesus, and both the titles, Christ and Lord.

##### Edit Ranges

Setup Custom Ranges - You can enter upper and lower boundaries for the search by clicking on the Setup Custom Ranges button.

Change Range Entry Box

The predefined ranges show examples of the required syntax.

Click on the Add New Range enter the name for your range in the Name text entry box, and enter the range in the text entry box labled Edit the search range. Your range is now added to the list of custom ranges. If you are satisfied you can return to the Search Options tab by clicking on OK.

A number of custom ranges have been provided.

The scope of a search can be set to the Entire Module or the Current Results. If Entire Module is checked and a search of the KJV Bible module is done for the name, Jesus, 939 matches will result. Then if Current Results is checked and another search is done for the title, Christ, 257 matches from the first 939 matches will remain. Then if Current Results remains checked and another search is done for the title, Lord, 106 matches from the 257 will remain. All the remaining 106 matches will have the name, Jesus, and both the titles, Christ and Lord.

Search TextCustom Range Dialog Box

##### Using the Search Text Button

Click on the Search Button to start the search.

Search Text Dialog Box

#### The Search Results Tab

Under the search results tab you will find the all of your search hits.

##### Using the Search Results Tab

Search Result - This tells you first, by module, how many instances of the search string were found. In the Module Column, clicking on a document will open the list of references (clicking with the right mouse button allows you to copy, save, or print the list of items found). Clicking on a reference (the found items list) opens that verse up in the window below. Drag the reference and drop it on a document in the main index to open the module to that verse in a new display window, or look at the verse in the bottom pane of the search results tab.

Drag & Drop Works Here in the text display area.

Select verse numbers and drag them to the main index to create bookmarks.

Select verse numbers and drop them on an unopened module in the main index to open the module and jump to the verse location (Bibles and commentaries only).

Select verse numbers and drag them to an open document and the document will jump to the verse location (Bibles and commentaries only).

Search Result Dialog Box

##### Using the Search Analysis

Click on Search Analysis to open the search analysis display.

Search Analysis - This gives a graphic analysis of the number of instances the search string was found in each book. It can display results for all documents searched. You have the option of saving the analysis as an html formated list on your hard drive.

Search Analysis Dialog Box

## Search Syntax using GCC Regular Expression

Regular expression searches provide a way to do simple or complex searches for strings that match a pattern or set of patterns (branches) separated by vertical bars "|". While a pattern can be built to look for a word or phrase, a simple pattern that consists of a word does not look for only that word but for any place the string of letters that make that word are found. A search for "right" will return verses that contain the word "right", but also "righteous", "righteousness", "unrighteous", "upright" and even "bright". A search for "hall not" is not a search for "hall" AND "not" but for the string "hall not" with a space between the second "l" and the "n". The search for "hall not" will find occurrences of "shall not".

The power of Regular Expressions is in the patterns (or templates) used to define a search. A pattern consists of ordinary characters and some special characters that are used and interpreted by a set of rules. Special characters include .\[^*$?+. Ordinary (or simple) characters are any characters that are not special. The backslash, "\", is used to convert special characters to ordinary and ordinary characters to special.

Example: the pattern "i. love\." will find sentences that end with "his love" or "in love" or "is love" followed by a period. The first period in "i. love\." is a special character that means allow any character in this position. The backslash in "i. love\." means that the period following it is not to be considered a special character, but is an ordinary period.

### Rules for GCC Regular Expression Search Requests

- . The period matches any character. See Details

- * The asterisk matches 0 or more characters of the preceding: set, character or indicated character. See Details

- + The plus sign matches 1 or more characters of the preceding: set, character or indicated character. See Details

- ? The question mark matches 0 or 1 character of the preceding: set, character or indicated character. See Details

- [ ] Square brackets match any one of the characters specified inside [ ]. See Details

- ^ A caret as the first character inside [ ] means NOT. See Details

- ^ A caret beginning a pattern anchors the beginning of a line. See Details

- $ A dollar at the end of a pattern anchors the end of a line. See Details

- | A vertical bar means logical OR. See Details

- ( ) Parentheses enclose expressions for grouping. Not supported!

- \ A backslash can be used prior to any special character to match that character. See Details

- \ A backslash can be used prior to an ordinary character to make it a special character. See Details

#### The Period .

The Period "." will match any single character even a space or other non-alphabet character. s.t matches sit, set, sot, etc., which could be located in sitting, compasseth and sottish b..t matches boot, boat and beat foot.tool matches footstool and foot tool

#### The Asterisk *

The asterisk matches zero or more characters of the preceding: set, character or indicated character. Using a period asterisk combination ".*" after a commonly found pattern can cause the search to take a very long time, making the program seem to freeze. be*n matches beeen, been, ben, and bn which could locate Reuben and Shebna.

#### The Plus Sign +

The Plus Sign matches one or more characters of the preceding: set, character or indicated character. Using a period and plus sign combination ".+" after a commonly found pattern can cause the search to take a very long time, making the program seem to freeze. be+n matches beeen, been and ben, but not bn.

#### The Question Mark ?

The Question Mark matches zero or one character of the preceding: set, character or indicated character. be?n matches ben and bn but not been. trees? matches trees or tree.

#### The Square Brackets [ ]

The Square Brackets enclose a set of characters that can match. The period, asterisk, plus sign and question mark are not special inside the brackets. A minus sign can be used to indicate a range. If you want a caret "^" to be part of the range do not place it first after the left bracket or it will be a special character. To include a "]" in the set make it the first (or second after a special "^") character in the set. To include a minus sign in the set make it the first (or second after a special "^") or last character in the set. s[eia]t matches set, sit, and sat, but not sot. s[eia]+t matches as above but also, seat, seet, siet, etc. [a-d] matches a, b, c, or d. [A-Z] matches any uppercase letter. [.;:?!] matches ., ;, :, ?, or ! but not a comma. [ ]^-] matches ] or ^ or -

#### The Caret first in Square Brackets [^xxx

If the Caret is the first character after the left bracket it means NOT. s[^io]t matches set, sat, etc., but not sit and sot.

#### The Caret as Start of Line Anchor ^xxx

If the Caret is the first character in a pattern it anchors the pattern to the start of a line. Any match must be at the beginning of a line. Because of unfiltered formatting characters in some texts, this feature does not always work, but may if a few periods are placed after the caret to account for the formatting characters. ^In the beginning matches lines that start with "In the beginning". (May need to use: ^.....In the beginning)

#### The Dollar Sign as End of Line Anchor xxx$

If the Dollar Sign is the last character in a pattern it anchors the pattern to the end of a line. Any match must be at the end of a line. Because of unfiltered formatting characters in some texts, this feature does not always work, but may if a few periods are placed before the dollar sign to account for the formatting characters. Amen\.$ matches lines that end with "Amen." (May need to use Amen\....$, Amen\..........$, or even Amen\....................$)

#### The Vertical Bar |

The Vertical Bar between patterns means OR. John|Peter matches John or Peter. John .*Peter|Peter .*John matches John ... Peter or Peter ... John. (.* slows a search) pain|suffering|sorrow matches pain, or suffering, or sorrow.

#### The Parentheses ( )

The use of Parentheses ( ) is not supported!

#### The Backslash Prior to a Special Character \*

The Backslash prior to a special character indicates that the character is not being used in its special meaning, but is just to match itself. amen\. matches amen. but not ament and will not locate firmament.

#### The Backslash Prior to an Ordinary Character \s

The Backslash prior to an ordinary character indicates that the character is not being used to match itself, but has special meaning.

- \b if use outside [ ] means word boundary. If used inside [ ] means backspace. \brighteous\b matches righteous but not unrighteous or righteousness

- \B means non-word boundary. \Brighteous\B matches unrighteousness and unrighteously but not righteous, unrighteous or righteousness.

- \d means digit; same as [0-9].

- \D means non-digit, same as [^0-9].

- \s means space.

- \S means not a space.

- \w means alphanumeric; same as [a-zA-Z0-9_].

- \W means not alphanumeric; same as [^a-zA-Z0-9_].

## Exporting and Printing

Bible Window, Lexicon Window, Commentary Window, Book Window.

By clicking with the right mouse button on the index key number, verse number or text the Bible Window, Lexicon Window, Commentary Window or Book Window drop down box is displayed (depending on which kind of window is current), providing options to select all, and the export options copy, add to printing queue, and save.

### Select All

A mouse click here will select all of the text in the chapter displayed in the current window.

### Copy

A mouse click here will bring up a sub menu offering to copy to the copy buffer using the current location of the cursor as the starting point.

- Reference only - The number of the current verse (such as Genesis 1:25).

- Text of Reference - The text of the current verse.

- Reference with Text - Both the text of the current verse, and the verse number.

- Chapter - the entire chapter.

- Selected Text - Only the selected (highlighted) text.

This text can be copied into any application that can access the linux copy buffer.

### Add to Printing Queue

Selecting print here puts your print output in the bibletime print buffer. Inorder to send your job to the printer (lpr) via kprinter, you must select file print on the menubar.

A mouse click here will bring up a submenu with the printing options:

- reference with text

- chapter

Selecting these places text into the bibletime print queue, but it will not print yet. When all of the items that you desire to print are copied to the print queue, select the print icon and the print dialog window is displayed. Now you can select to either view or print the text.

Printing from &bibletime; is rather basic and is intended as a utility. If you are composing a document or presentation containing text from &bibletime; documents, we suggest that you use one of the presentation or editing tools on your system to format your work.

### Save

A mouse click here will bring up a submenu with save options:

- Verse with reference - a file is created in &UNIX; formated ASCII text.

- Chapter as plain text - a file is created in &UNIX; formated ASCII text.

- Chapter as HTML - a file is created formated in HTML.

Once saved this text can be opened and edited by any text or HTML application.