pasquale
12-17-2006, 12:42 AM
If you're going to create a Bibleworks Module you need some helps.
My personal attention points (I am not responsible for a bad use of this help):
For a complete help you must use Bibleworks help
Question = In what directory I must insert my project files?
Answer = To edit a Bibleworks module all files of your project must be in the same directory (only one directory).
Question = How to call my files?
Answer = Better is to have a progressive numbers, I generally use 10001.htm, 10002.htm and so on.
Why I use this names for my files?
Because when you Tags your files with Bibleworks tool Build Module Index, this tool tags every files (that are in your project directory) and make an index (file sdx) that Bibleworks need to link the Bible with your new module. The tool makes also another files with extension YourProjectName_idx.txt in this file to open with wordpad you can to look into what file are indexed, therefore if you use a progressive numbers you can to look if all files are indexed (Build Module index can jump some files).
Question: My files can be tagged normally?
Answer: No there Is a Javascript to put into the file, therefore open every html file and Edit your html file inserting after The title:
<title>YOUR TITLE</title>
<script language="JavaScript" src="bwjs.js"></script>
</head>
<BODY onkeypress="BwOnKeyPress()" onload="BwOnLoad()">
red is only for explanation
Advice: I have edited - with the BW scripts - 122 files in progressive numbers that I use for all my works. (you can rename it with a free tool LupasRename)
Question = What is Bwjs.js?
Answer: It is an essential script. There is in a zip file in the directory (where you have Bibleworks) generally c:\Program files\Bibleworks\sampleHTMLHelp.zip the file zip where into is bw.js. You must insert this bw.js in your project directory. (where are your html file, your work);
Question = What Bible references I must use?
Answer = You must use Roman digit and in this form: Three Bibleworks Book Name: Gen, Deu, Mat, Mar… et alia, Mat 1:1-4 and so on, don't use this reference Mat 1:1-2:4 but for the same reference use Mat 1:1-25 and Mat 2:1-4; don't use Deu 20, but use Deu 20:1-20.
Question Where are I put the file mymodule-books.txt?
Answer: renam it so YourProjectfileName-book.txt and put it in the same directory of the project. (At the bot of this help there are some notes how it works)
Question = When I must open Build Module Index?
Answer: After you have edited every project files, open Bibleworks, Tools Build Module Index, select your project directory and click on Tag and Build Index (if you works in different time – to day I tag some files, and tomorrow I want tag others files, it is not a good system, you must move your file already tagged in another directory and after Tag and Build index the new files. At the end of the works move all files in the same directory , open Bibleworks Tools Build Module index and cick on Build Index Only.
Now you have your files tagged to works with the scripts, you also have the file YourProjectName.sdx (it is the index), YourProjectName_idx.txt (to manage the file indexed). Now you must build your chm file (with HTML workshop or much easier with a chm compiler or creator et alia).
But before to have a good work you must open one by one your files in the browsers (internet explorer) to see and correct some bad o fake links. Bibleworks Build module Index there isn't perfect,
You must edited your modules, and after manually correct some fakes links (or not linked).
After editing you open still Bibleworks Tools Build Module index and click on Build Index Only. (Bibleworks build a new sdk).
Question = Now I have this file YourProjectName.chm, YourProjectName.sdx (the last edited), YourProjectName._idx.txt. I have finished?
Answer= No. Now you must create the file chd (advice, copy in your Project directory and open an existent chd (it is in Bibleworks databases directory and open it with notepad) and adapt it at your project and save it with YourProjectName.chd).
Finally copy in your Bibewors databases directory three file (the chm, the sdk and the chd), remember share it if it is in Public Domain or your personal write with other users from this forum or if copywrited use only for your personal use.
Tool:
1) An html editor;
2) from microsoft "HTML workshop" it is free;
3) Third tool for making a chm file easier a chm compiler/decompiler (search in internet a free chm creator or compiler or maker - it is free: Abee CHM Maker 1.0 - on Tucows - I don't know how it works it is to try).
4) Lupas rename free - for rename many files at the same time;
5) another tool that search and repalce (search words into the codex of html file (without open the file) and replace (without open the file) directly in the codex html with others words (search and replace into many files at the same time).
Question = How to develope a greek-another language dictionary module?
Answer = To develope a greek dictionary module - at the moment - you must create an html file for every word of the dictionary (5500 words=5500 files html) and in every html file you must insert the scripture reference concordace of the specific word, and the title inserted into the html codex must be it: <title>Word1</title>, <title>Word2</title> and so on.
Question = What is the font to use?
Answer = What you prefer, it is not indispensable a Bibleworks font.
Question = It is an hard work to develope a complete greek-another language dictionary?
Answer = It is a very very hard work......
Ciao Pasquale
How works mymodule-books.txt (before open the file with wordpad or notepad)
#BETWEEN_CHAPTER_VERSE_MARKERS :
Designates the characters that can appear between a chapter and verse reference. In the US, it is usually ':' (e.g. John 3:16, Rom 3:23). In the UK, it is usually '.' (e.g. John 3.16, Rom 3.23).
#BETWEEN_REF_MARKERS ;,
Designates the characters used between references. For example, in this example, "John 3:16; Rom 3:23", the ";" is used between references. For example, in this example, "John 3:16; Rom 3:23, 6:23", the ";" and "," are used between references.
#RANGE_MARKERS -
Designates the characters used to designate a range of verses or chapters (e.g. "-" denotes a range of verses in the text "Joh 1:1-13").
#CHAPTER_NUMS_CAN_BE_PARENNED n
When set to 'y', this identifies parenthetical references such as "(3:23)"
in the text.
#SKIP_TAGS n
When set to 'y', this ignores text surrounded by <>, such as "<verse ref val="joh 1">".
#PRINT_BR_TAG_BTN_LINES y
When generating HTML from the input file, setting this value to 'y' will insert a <br> tag between lines.
#USE_AGGRESSIVE_LOOKAHEAD n
When set to 'y', this can help identify references that are being missed. It may, however, introduce errors, depending on the content of the input file.
My personal attention points (I am not responsible for a bad use of this help):
For a complete help you must use Bibleworks help
Question = In what directory I must insert my project files?
Answer = To edit a Bibleworks module all files of your project must be in the same directory (only one directory).
Question = How to call my files?
Answer = Better is to have a progressive numbers, I generally use 10001.htm, 10002.htm and so on.
Why I use this names for my files?
Because when you Tags your files with Bibleworks tool Build Module Index, this tool tags every files (that are in your project directory) and make an index (file sdx) that Bibleworks need to link the Bible with your new module. The tool makes also another files with extension YourProjectName_idx.txt in this file to open with wordpad you can to look into what file are indexed, therefore if you use a progressive numbers you can to look if all files are indexed (Build Module index can jump some files).
Question: My files can be tagged normally?
Answer: No there Is a Javascript to put into the file, therefore open every html file and Edit your html file inserting after The title:
<title>YOUR TITLE</title>
<script language="JavaScript" src="bwjs.js"></script>
</head>
<BODY onkeypress="BwOnKeyPress()" onload="BwOnLoad()">
red is only for explanation
Advice: I have edited - with the BW scripts - 122 files in progressive numbers that I use for all my works. (you can rename it with a free tool LupasRename)
Question = What is Bwjs.js?
Answer: It is an essential script. There is in a zip file in the directory (where you have Bibleworks) generally c:\Program files\Bibleworks\sampleHTMLHelp.zip the file zip where into is bw.js. You must insert this bw.js in your project directory. (where are your html file, your work);
Question = What Bible references I must use?
Answer = You must use Roman digit and in this form: Three Bibleworks Book Name: Gen, Deu, Mat, Mar… et alia, Mat 1:1-4 and so on, don't use this reference Mat 1:1-2:4 but for the same reference use Mat 1:1-25 and Mat 2:1-4; don't use Deu 20, but use Deu 20:1-20.
Question Where are I put the file mymodule-books.txt?
Answer: renam it so YourProjectfileName-book.txt and put it in the same directory of the project. (At the bot of this help there are some notes how it works)
Question = When I must open Build Module Index?
Answer: After you have edited every project files, open Bibleworks, Tools Build Module Index, select your project directory and click on Tag and Build Index (if you works in different time – to day I tag some files, and tomorrow I want tag others files, it is not a good system, you must move your file already tagged in another directory and after Tag and Build index the new files. At the end of the works move all files in the same directory , open Bibleworks Tools Build Module index and cick on Build Index Only.
Now you have your files tagged to works with the scripts, you also have the file YourProjectName.sdx (it is the index), YourProjectName_idx.txt (to manage the file indexed). Now you must build your chm file (with HTML workshop or much easier with a chm compiler or creator et alia).
But before to have a good work you must open one by one your files in the browsers (internet explorer) to see and correct some bad o fake links. Bibleworks Build module Index there isn't perfect,
You must edited your modules, and after manually correct some fakes links (or not linked).
After editing you open still Bibleworks Tools Build Module index and click on Build Index Only. (Bibleworks build a new sdk).
Question = Now I have this file YourProjectName.chm, YourProjectName.sdx (the last edited), YourProjectName._idx.txt. I have finished?
Answer= No. Now you must create the file chd (advice, copy in your Project directory and open an existent chd (it is in Bibleworks databases directory and open it with notepad) and adapt it at your project and save it with YourProjectName.chd).
Finally copy in your Bibewors databases directory three file (the chm, the sdk and the chd), remember share it if it is in Public Domain or your personal write with other users from this forum or if copywrited use only for your personal use.
Tool:
1) An html editor;
2) from microsoft "HTML workshop" it is free;
3) Third tool for making a chm file easier a chm compiler/decompiler (search in internet a free chm creator or compiler or maker - it is free: Abee CHM Maker 1.0 - on Tucows - I don't know how it works it is to try).
4) Lupas rename free - for rename many files at the same time;
5) another tool that search and repalce (search words into the codex of html file (without open the file) and replace (without open the file) directly in the codex html with others words (search and replace into many files at the same time).
Question = How to develope a greek-another language dictionary module?
Answer = To develope a greek dictionary module - at the moment - you must create an html file for every word of the dictionary (5500 words=5500 files html) and in every html file you must insert the scripture reference concordace of the specific word, and the title inserted into the html codex must be it: <title>Word1</title>, <title>Word2</title> and so on.
Question = What is the font to use?
Answer = What you prefer, it is not indispensable a Bibleworks font.
Question = It is an hard work to develope a complete greek-another language dictionary?
Answer = It is a very very hard work......
Ciao Pasquale
How works mymodule-books.txt (before open the file with wordpad or notepad)
#BETWEEN_CHAPTER_VERSE_MARKERS :
Designates the characters that can appear between a chapter and verse reference. In the US, it is usually ':' (e.g. John 3:16, Rom 3:23). In the UK, it is usually '.' (e.g. John 3.16, Rom 3.23).
#BETWEEN_REF_MARKERS ;,
Designates the characters used between references. For example, in this example, "John 3:16; Rom 3:23", the ";" is used between references. For example, in this example, "John 3:16; Rom 3:23, 6:23", the ";" and "," are used between references.
#RANGE_MARKERS -
Designates the characters used to designate a range of verses or chapters (e.g. "-" denotes a range of verses in the text "Joh 1:1-13").
#CHAPTER_NUMS_CAN_BE_PARENNED n
When set to 'y', this identifies parenthetical references such as "(3:23)"
in the text.
#SKIP_TAGS n
When set to 'y', this ignores text surrounded by <>, such as "<verse ref val="joh 1">".
#PRINT_BR_TAG_BTN_LINES y
When generating HTML from the input file, setting this value to 'y' will insert a <br> tag between lines.
#USE_AGGRESSIVE_LOOKAHEAD n
When set to 'y', this can help identify references that are being missed. It may, however, introduce errors, depending on the content of the input file.