You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTRUCTIONS.md
+28-6Lines changed: 28 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ You will have problems if you have other non-bible files in the directory with t
8
8
9
9
Start the **GoBibleCreatorUSFMPreprocessor** (**GBC_Tool** from here on out) utility. To get started, select the button in the top left corner with the "`...`" to open a directory selector tool. Navigate to your directory on your machine that has the USFM files that you want to check.
Use the **USFM file extension** dropdown to select the correct file extension that corresponds your USFM files.
12
14
13
15
Once you have done this, you are now ready to use most of the utilites on any of the tabs. However, for things like the **Export to DigiStudy format**, you really do need to have clean, extra tag free files.
@@ -16,6 +18,8 @@ Once you have done this, you are now ready to use most of the utilites on any of
16
18
17
19
For **GoBibleCreator** to work properly, you must convert your regular ASCII text that uses a codepage to a Unicode compliant text file (UTF-8). If you are already working with UTF-8 formatted files, then skip this step. The following utility should be able to do that without any problems as long as you specify the proper codepage that your files are in. Notice that your original files will not be altered and new files will be created. These files will have a new extension (.utf by default). Press the **Convert Files to UFT-8** button to process the conversion.
18
20
21
+
22
+
19
23
### *Grabbing Bible Book Names*
20
24
21
25
When you are making a collection's file for GoBibleCreator [url:], one of the tasks that you are required to do is create the book name tags in the file. GoBibleCreator is very fussy about this and requires that the book names specified in the collections file match up exactly with the book name specified in the USFM document. If they don't, GoBibleCreator will quit and give you and error. To help in creating that collections file, there is a function which will go into each of your USFM files and extract the book name for you and create the correct format for you to cut-and-paste into your file.
@@ -24,6 +28,8 @@ About the only thing you need to specify is the correct tag in your USFM which h
24
28
25
29
**Note:** you will still need to go into the collections file and order the books in the order you want. Book display order is specified there.
**GoBibleCreator** only will process the standard tags that have been specified in the USFM reference manual [url:]. However, **ParaTExt** allows the individual user to create their own tags for their specific situation. While this is a good thing, it will cause problems in **GoBibleCreator**, as it doesn't know what to do with these tags. Therefore, this function will let help you preprocess these tags out of your document so that it doesn't pose a problem when you get around to converting.
@@ -32,8 +38,8 @@ By pressing the **Scan for Tags that will not be Processed by GBC (UTF-8 Files O
32
38
33
39
At this point, you have five options in how you want to deal with the tag:
34
40
35
-
1.**IGNORE TAG** - does what it says, lets you ignore the tag.
36
-
Note that this tag will show up in your final bible text on GoBible if you select this.
41
+
1.**-IGNORE TAG-** - does what it says, lets you ignore the tag.
42
+
Note that this USFM tag will show up in your final bible text on **GoBible** if you select this.
37
43
2.**Remove Singular Tag - Remove Tag Only** - This selection is designed to remove tags that only have a start tag and not an end tag. With this command, the program will remove only the tag from your USFM files but leave everything that surrounds the tag.
38
44
3.**Remove Singular Tag - Remove Tag and Remainder of line** - This selection is designed to remove tags that only have a start tag and comments that take up the whole line. With this command, the program will remove from your USFM files the tag itself and the rest of the line to the right of it.
39
45
4.**Remove Double Marker Tags (Only) - leave text in between** - This selection is designed to remove tags that have both a starting and ending tag (e.g., `\ui ... \ui*` ). All text between the tags is left as valid bible text that you want to show up in GoBible.
@@ -42,6 +48,7 @@ Note that this tag will show up in your final bible text on GoBible if you selec
42
48
43
49
In the rightmost cell of each grid, there is a dropdown that lets you control the action of how you want that tag processed.
@@ -56,6 +63,8 @@ Another feature of this tab is to search for long words.
56
63
>
57
64
> *Choose desired number of letters for long words (the default is 15) and choose one of those options. Then click the **Find All Long Words** button. Generated results will be placed in clipboard. You can use Excel™ to paste and view the results.*
58
65
66
+
67
+
59
68
### *Export to BQ/DigiStudy Format*
60
69
61
70
This tab will allow you to export your USFM files into a DigiStudy or BibleQuote format. First make sure you filled out all the fields on this tab.
@@ -65,7 +74,11 @@ On the following line specify the entire alphabet of the language of the Bible.
65
74
66
75
On the next line specify HTML tag that will be used as a beginning of the chapter sign and beginning of new verse sign. In the bottom right corner type what tag is used in USFM files to specify Bible book name.
67
76
68
-
For languages that have specific characters check a Swap Characters for HTML friendly codes check-box in the bottom left corner. Another form will pop up. There you will find instructions for typing in specific characters and corresponding HTML code. You can use an existing character definition code in .xml format by pressing Open Existing Char Definition File button or save the characters and HTML codes that you type in by pressing Save Char Definition File button.
77
+
78
+
79
+
For languages that have specific characters check a **Swap Characters for HTML friendly codes** check-box in the bottom left corner. Another form will pop up. There you will find instructions for typing in specific characters and corresponding HTML code. You can use an existing character definition code in .xml format by pressing Open Existing Char Definition File button or save the characters and HTML codes that you type in by pressing Save Char Definition File button.
80
+
81
+
69
82
70
83
Close this form when your are ready. All character definitions will be saved in memory and used when you start to generate BQ export. To export the Bible press **Generate BQ Export** button. Wait for a couple of minutes for it to finish.
71
84
@@ -76,10 +89,14 @@ First, make sure your .sfm files are formatted correctly or in a way that makes
76
89
77
90
To do that click Open Folder |…| button in the upper left corner and choose a folder containing your .sfm files. Then open Extra Tags Processor tab and click the button **Scan the Tags that will not be processed…**. Make sure that USFM File Extension drop down above has the right extension selected.
In this case scanning showed that there are a lot of closing `\fr*` tags (USFM Preprocessor uses one of the earlier versions of USFM Reference as a standard, which didn’t support closing tags for the `\fr ` and some other tags).
80
95
81
96
In order for the program to process epub file correctly, you’ll need to get rid of these tags. To do that, choose **Remove Singular Tag** from a drop down menu next to the tag:
Do this for each tag and then click **Process Tags and Create New Files** button in the bottom.As a result you will have a new set of files with .utf extension, if you didn’t change the default.
84
101
85
102
Next switch to the **Export as ePub** tab and choose utf file extension in the USFM File Extension drop down above. Now you’re ready to import your .utf or .sfm (if you didn’t need to change anything on the previous step) files into epub format.
@@ -88,12 +105,16 @@ Now you need to set your books in the right order. To do that, click **Set Book
88
105
89
106
In the Set Book Order window that will open click Grab Books button. If your book name tag is not `\h`, then change it. As a result the grid will be filled out with your .utf or .sfm files in existing order. You can drag files up and down to put your books in desired order. Or you can click on **Load Existing Book Order** to load the order you saved previously. When you’re done putting your books in order, click **Save Order**, in the bottom of the window.
90
107
108
+
109
+
91
110
A message will pop up with the name of your book order text file.
92
111
93
112
Now click **Load Books from book order file** button on the main screen. As a result the grid below the button will be filled with the names of the files. At this point you can select the files you would like to output in ePub format. You can also reorder the files if you are not satisfied with the order. You can select all the files by clicking on the grid header for the first column. It says **Select All**.
94
113
95
114
Then fill out all the fields to the right of the grid. Check **Paragraph mode** check box in the bottom if you want the text come in paragraphs. Provide Cover Page Title, Bible Name, Description, ISBN, Publisher info and so on in the **Title Page info** text field.
If your Bible has introduction for each book of the bible, provide the name of this introduction in your language in the **Intro Name** field.
98
119
99
120
There are two more optional things that you will need for your epub file. They have to do with formatting: cover page image and css file. If you want to include them, download two additional folders in a zip file css and images.zip.
@@ -120,8 +141,9 @@ To look inside, edit, and repackage your epub file we found it the most helpful
120
141
121
142
*Last updated on CodePlex: Nov 30, 2012 at 4:32 AM by anyalee, version 22*
122
143
123
-
*Text transcribed and formatted for GitHub: 11/17/2017 7:34:04 PM by David Haslam.*
144
+
*Text transcribed and formatted for GitHub: 11/17/2017 8:55:44 PM by David Haslam.*
145
+
146
+
*Images are from the original [Documentation](https://gbcpreprocessor.codeplex.com/documentation)*
124
147
125
148
##### TBD
126
-
- Insert images from the original [Documentation](https://gbcpreprocessor.codeplex.com/documentation)
127
-
- Fix links where required.
149
+
- Fix links where required (e.g. in the **Embedding fonts** section).
0 commit comments