MySword for Android Migration Tools v.2.3
August 18, 2012

How to use these set of Migration tools.

Note that the executable files were designed to work in the Console (Command
prompt, or what many people know as the DOS prompt).

1. What's New in Version 2.3
2. What's New in Version 2.2
3. What's New in Version 2.1
4. What's New in Version 2.0
5. What's New in Version 1.2
6. What's New in Version 1.1
7. Installation
8. Migrating TheWord Bible Modules
9. Migrating TheWord Commentary Modules
10. Migrating TheWord Dictionary Modules
11. Migrating TheWord Book/Devotional/Graphics Modules
12. Migration Errors
13. Known Issues

1. What's New in Version 2.3
	
	a. RTF2MySwordHTML.dll improvements:
		1) MLSJ conversion of special Hyperlink tw://*.*?txt=Entry will be
			properly converted. Currently, this is just converted to a
			self-link which actually means there is no entry in MLSJ as only
			Greek entries exist.
		2) bold/italic wrapping hyperlinks are now properly converted.
		3) initial support for RVF bullets and numbers lists including nesting.
			New lines (breaks entered in TheWord via Shift-ENTER) in items are
			also supported.
		4) support for Bible links without tags in RTF conversion if the format
			is BookAbbr_Chapter_Verse(range), e.g. Joh_3:16. This is because
			copy-paste of links in e-Sword Study Notes then migrate to TheWord
			commentary may not have link tags.
		5) RTF fonttbl whose list are separated by new lines are now ignored.
		6) RTF Bible links will now use the custom text link for display so
			that you can now see Bible links like "Ps lxx 1" as in Matthew
			Henry.
		7) RVF dictionary links without tid= is now supported.
		8) RTF dictionary links will now use the custom text link for display.
		9) RTF commentary self links will now work and not linked to
			dictionary entry.
	b. Updated TheWordBible2MySword.exe to include the publish.date if present
		in the TheWord file. Also made the logic that extracts information at
		the end of the TheWord file case-insensitive (some modules use About
		instead of about).
	c. Updated the dictionary migrator so that empty entries are excluded and
		will no longer throw an exception of Specified cast is not valid.
	d. Updated the commentary migrator so that the record that cause an error
		will be indicated so that it can be rectified.
		
2. What's New in Version 2.2
	
	a. Initial support for RTL for Commentary, Dictionary and Book migration.
		The r2l field is now copied to a new field in the details table
		righttoleft and used by MySword 2.0 RC3 for proper alignment. However,
		the Android device must have the patch that manufacturers normally
		provided for their Arabic and Hebrew customers or the Android version
		must be at least Honeycomb.
		
	b. Updated RTF2MySwordHTML.dll so that the conversion of the RFT Unicode
		escapes of the form \u9999 will also ignore the possibly succeeding
		space. This will remove the unnecessary space in between Greek letters
		in Strong's dictionary.
		
	c. RTF fonttbl (font table) support. An RTF content not using Unicode
		escapes (old RTF version) but with Greek, Hebrew and Baltic character
		sets can now be properly converted (will not use one global character
		set). The makers of the K&D and other modules actually stripped off
		the font table from the content (maybe to reduced the size) so there
		is now a default list of fonts:
			font 0 (default) - Windows-1252
			font 1 - Greek - Windows-1253
			font 2 - Hebrew - Windows-1255
	
	d. Dictionary originally in RTF format converted to RVF via TheWord's
		"Detect all verse references..." still has data in Text data type
		causing no data to be migrated using the old migrator.
		
	e. Fixed the RTF migration of Bible reference with verse 0 and dropped the
		:0, e.g. Psa 92:0 will become Psa 92, as reported by Peter Pellerin.
	
3. What's New in Version 2.1
	
	Fixed picture extraction bug in RTF2MySwordHTML.dll for RVF content whose
	embedded picture contained extra RVF Strings (used for height and width).
	Morrish Galilee does not show as reported by a user because the image is
	invalid due to extra bytes at the beginning. The American Tract dictionary
	is also affected. Here are the entries affected:
	
	a. Morrish
		Accad
		Embalming
		Fig, Fig-tree
		Galilee
		Seasons - two pictures at the end
	
	b. American Tract
		Idol, Idolatry
		Sepulchre - 3rd picture
		Shalmaneser
	
4. What's New in Version 2.0
	
	a. Migration of TheWord Book, Devotional and Graphics Modules. The modules
		created require at least MySword version 2.0.
	
	b. Numerous fixes in RTF2MySwordHTML.dll's RTF and RVF conversion routines.
		Notably, the problem with Hebrew fonts in Barnes, some missing sections
		in Clarke, About/Comments in Bible having \'XX where X is a hexadecimal
		number are fixed. The appropriate Character Encoding to use for RTF's
		\'XX must be set in the *.config file of the specific migrator EXE.
	
	c. Graphics support for Books/Journals (to make the Maps possible),
		Dictionaries (Morrish now grew from being 4MB to 18MB due to pictures,
		and we now have American Tract Society Bible Dictionary with pictures)
		and Commentaries (have not yet tested though).
	
	d. Initial support for RTL for Bible migration. The r2l field is now copied
		to details table's RightToLeft and used by MySword 2.0 for proper
		alignment. However, the Android device must have the patch that
		manufacturers normally provided for their Arabic and Hebrew customers.
	
5. What's New in Version 1.2

	a. Corrected some bugs in the RTF2MySwordHTML.dll used by
		TheWordDictionary2MySword and TheWordCommentary2MySword.
	
	b. Trimmed also the Dictionary subject some words in French Strong's of
		Daniel Poulin have trailing space so a strong link tap from the Bible
		may not find an entry.
	
	c. Also, updated all migrators except Bible so that it will prompt the user
		if the module is compressed or encrypted and cannot be migrated.
	
6. What's New in Version 1.1

	TheWordDictionary2MySword is updated to support self references or links
	to entries in the same dictionary module using ID numbers instead of
	word key. Version 1.0 only supports word keys and Strong's numbers. The
	need arises when migrating Noah Webster's 1828 Dictionary of American
	English.
	
7. Installation

	This program is designed to run in Microsoft Windows with .NET Framework
	3.5. It has not yet been tested in Mono Framework.
	
	Simply unzip the archive file to a certain location.
	
	For 64-bit Windows, please copy the System.Data.SQLite.DLL file located at
	the x64 folder into the main folder overwriting the same file there (which
	is actually for 32-bit Windows).

8. Migrating TheWord Bible Modules

	Open a Command Prompt (CMD.exe) and go to the location where you unzipped
	the archive file and make sure you go to the inside folder
	(MySwordMigrationTools).
	
	In the Command Prompt, if the module to be migrated is bbe.ont and is
	placed in the same folder where the executables are, type the following:
	
		TheWordBible2MySword bbe.ont
		
	This will create bbe.bbl.mysword. You can now just copy this file into your
	selected Modules Path/Folder in your Android device.
	
	Please note that the TheWord .ot, .nt or .ont file must be in UTF-8 format
	for the migration to be successful unless only 7-bit ASCII characters are
	in the file. To determine if the file is in UTF-8 format, you can open it
	in Notepad++ and go to the Encoding menu. To change the format to UTF-8
	format, select Encoding->Convert to UTF-8 without BOM, then save the file.
	You can also opt to use UTF-8 with BOM if you want. After this, you can now
	use TheWordBible2MySword.
	
	You can also check the resulting SQLite database outside MySword by using
	Firefox SQLite Manager plugin/extension. Open the migrated file and check
	the contents by going to Bible table and selecting Browse & Search tab.
	Check if there are no problems with the text.

9. Migrating TheWord Commentary Modules

	Open a Command Prompt (CMD.exe) and go to the location where you unzipped
	the archive file and make sure you go to the inside folder
	(MySwordMigrationTools).
	
	In the Command Prompt, if the module to be migrated is tsk.cmt.twm and is
	placed in the same folder where the executables are, type the following:
	
		TheWordCommentary2MySword tsk.cmt.twm
		
	This will create tsk.cmt.mysword. You can now just copy this file into your
	selected Modules Path/Folder in your Android device.
	
	You can also use Firefox SQLite Manager plugin/extension to see the output
	SQLite database without using MySword. Check the Commentary table.

10. Migrating TheWord Dictionary Modules

	Open a Command Prompt (CMD.exe) and go to the location where you unzipped
	the archive file and make sure you go to the inside folder
	(MySwordMigrationTools).
	
	In the Command Prompt, if the module to be migrated is eastons.dct.twm and
	is placed in the same folder where the executables are, type the following:
	
		TheWordDictionary2MySword eastons.dct.twm
		
	This will create eastons.dct.mysword. You can now just copy this file into
	your selected Modules Path/Folder in your Android device.

	You can also use Firefox SQLite Manager plugin/extension to see the output
	SQLite database without using MySword. Check the Dictionary table.

11. Migrating TheWord Book/Devotional/Graphics Modules
	
	TheWord General Book (*.gbk.twm) Devotional (*.dev.twm) and Maps/Graphics
	(*.map.twm) all have the same format and can be migrated to MySword v.2.0
	Journal or Book format (*.bok.mybible). This migration program will
	automatically use the extention .bok.mybible but you can always rename it
	to .jor.mybible. Also, the migration program will automatically set the
	readonly field in the details table to 1. If you intend to allow editing
	of the journal/book in MySword, you will have to set it to 0 manually
	(please see below on how you can use Firefox and SQLite manager to do
	that). But please note that Journal/Book editing in MySword is limited to
	7 entries if the Premium Version is not activated. This can be activated
	for a generous donation of any amount to support MySword development,
	hosting and support.
	
	Open a Command Prompt (CMD.exe) and go to the location where you unzipped
	the archive file and make sure you go to the inside folder
	(MySwordMigrationTools).
	
	In the Command Prompt, if the module to be migrated is eastons.dct.twm and
	is placed in the same folder where the executables are, type the following:
	
		TheWordBook2MySword wight-manners.gbk.twm
		
	This will create eastons.dct.mysword. You can now just copy this file into
	your selected Modules Path/Folder in your Android device.

	You can also use Firefox SQLite Manager plugin/extension to see the output
	SQLite database without using MySword. Check the Dictionary table.

12. Migration Errors

	Note that Bible References that do not have correct book number and chapter
	number will not be properly migrated (so there will be no link) but the
	migration process will still continue. The errors are reported to the
	console though.
	
13. Known Issues

	The migration program will crash in case of IO Exceptions like the one
	triggered when the .mysword file is opened in Firefox SQLite Manager or
	you are running the wrong version of System.Data.SQLite.DLL (32-bit in a
	64-bit Windows for example).
	