Converting SFM Bibles to OSIS - Revision history

David Haslam: /* orefs.py */ updated description after the script was withdrawn from github

2023-06-05T14:02:34Z

orefs.py: updated description after the script was withdrawn from github

← Older revision		Revision as of 14:02, 5 June 2023
Line 155:		Line 155:

	===== orefs.py =====		===== orefs.py =====
	* [[Converting SFM Bibles to OSIS#Adyeths\|Adyeths]] ~~has~~ an ancillary script <tt>orefs.py</tt> to add the proper '''osisRef''' attribute to OSIS reference elements.<ref>This ~~is fairly~~ new (as of 2017-12-12) – it ~~does~~ not require SWORD bindings for Python.</ref>		* [[Converting SFM Bibles to OSIS#Adyeths\|Adyeths]] once had an ancillary script <tt>orefs.py</tt> to add the proper '''osisRef''' attribute to OSIS reference elements.<ref>This was new (as of 2017-12-12) – it did not require SWORD bindings for Python. He has since withdrawn the script due to insurmountable difficulties. There are no plans to re-instate it.</ref>

	'''Notes:'''		'''Notes:'''

Jaak: /* Checking USFM files for versification issues */ Updated GoBibleCreator USFM Preprocessor link URL

2019-03-18T11:22:41Z

Checking USFM files for versification issues: Updated GoBibleCreator USFM Preprocessor link URL

← Older revision		Revision as of 11:22, 18 March 2019
Line 19:		Line 19:

	===Checking USFM files for versification issues===		===Checking USFM files for versification issues===
	Rather than waiting until you have the end result, a SWORD module, and then running the general utility '''emptyvss''', it is possible to use another Windows based utility called [~~http~~://~~gbcpreprocessor.codeplex~~.com/ GoBibleCreator USFM Preprocessor]. Despite its name, its use is not limited to conversion of documents for use towards making Go Bible applications. Although this was originally developed for supporting the Go Bible project, it does have some useful more general features. This is one of them, and is found under the "Check for Consistency" tab. Another is the ability to export the USFM Bible into BQ/DigiStudy format. The Search for Versification Issues is particularly helpful for Bibles structured primarily as "verse per line", rather than as paragraphs containing a verse range. Another useful feature is the identification of non-standard markers.		Rather than waiting until you have the end result, a SWORD module, and then running the general utility '''emptyvss''', it is possible to use another Windows based utility called [https://github.com/GeoDirk/gbcpreprocessor GoBibleCreator USFM Preprocessor]. Despite its name, its use is not limited to conversion of documents for use towards making Go Bible applications. Although this was originally developed for supporting the Go Bible project, it does have some useful more general features. This is one of them, and is found under the "Check for Consistency" tab. Another is the ability to export the USFM Bible into BQ/DigiStudy format. The Search for Versification Issues is particularly helpful for Bibles structured primarily as "verse per line", rather than as paragraphs containing a verse range. Another useful feature is the identification of non-standard markers.

	=== USFM tag statistics ===		=== USFM tag statistics ===

David Haslam: /* Cross-references */ ===== Fixing references ===== There are two distinct process steps required in order to correctly fix vernacular references: 1. To create a separate '''reference''' element for each ''noncontiguous'' reference. 2. To assign the corr

2019-02-06T17:22:54Z

Cross-references: ===== Fixing references ===== There are two distinct process steps required in order to correctly fix vernacular references: 1. To create a separate '''reference''' element for each ''noncontiguous'' reference. 2. To assign the corr

← Older revision		Revision as of 17:22, 6 February 2019
Line 147:		Line 147:

	==== Cross-references ====		==== Cross-references ====
	<tt>usfm2osis.py</tt> and <tt>usfm2osis.pl</tt> do not produce [[OSIS Bibles#Marking_cross-references_notes\|cross-references]] (or [[OSIS Bibles#Marking_parallel_passage_headings\|parallel passage headings]]) that work properly as links with SWORD.<ref>A solution for this was envisaged in the original roadmap for <tt>usfm2osis.py</tt></ref> If your text contains such, you need <tt>xreffix.pl</tt> which sits in directory [https://crosswire.org/svn/sword-tools/trunk/modules/crossreferences/]. Using it requires the SWORD Perl bindings be installed and a [[DevTools:Locale Files\|sword-locale]]<ref>If the locale file has any errors or omissions, some references may end up with an incorrect osisRef. Thorough checking of the converted file is paramount.</ref> for the language of the module to be created.<ref>Special care is required when the cross-reference (or heading) includes additional text which is not a scripture reference. Until all these issues are fixed, it becomes almost impossible to parse the reference elements correctly such that the OSIS references can be added automatically.</ref>		<tt>usfm2osis.py</tt> and <tt>usfm2osis.pl</tt> do not produce [[OSIS Bibles#Marking_cross-references_notes\|cross-references]] (or [[OSIS Bibles#Marking_parallel_passage_headings\|parallel passage headings]]) that work properly as links with SWORD.<ref>A solution for this was envisaged in the original roadmap for <tt>usfm2osis.py</tt></ref> If your text contains such, you may need <tt>xreffix.pl</tt> which sits in directory [https://crosswire.org/svn/sword-tools/trunk/modules/crossreferences/]. Using it requires the SWORD Perl bindings be installed and a [[DevTools:Locale Files\|sword-locale]]<ref>If the locale file has any errors or omissions, some references may end up with an incorrect osisRef. Thorough checking of the converted file is paramount.</ref> for the language of the module to be created.<ref>Special care is required when the cross-reference (or heading) includes additional text which is not a scripture reference. Until all these issues are fixed, it becomes almost impossible to parse the reference elements correctly such that the OSIS references can be added automatically.</ref>

			===== Fixing references =====
			There are two conceptually distinct process steps required in order to fix vernacular reference strings:
			# To create a separate '''reference''' element for each ''noncontiguous'' reference.
			# To assign the correct '''osisRef''' attribute to each reference element.

	===== orefs.py =====		===== orefs.py =====
	* [[Converting SFM Bibles to OSIS#Adyeths\|Adyeths]] ~~now~~ has an ancillary script <tt>orefs.py</tt> to add the proper '''osisRef''' attribute to OSIS reference elements.<ref>This is fairly new (as of 2017-12-12) – it does not require SWORD bindings for Python.</ref>		* [[Converting SFM Bibles to OSIS#Adyeths\|Adyeths]] has an ancillary script <tt>orefs.py</tt> to add the proper '''osisRef''' attribute to OSIS reference elements.<ref>This is fairly new (as of 2017-12-12) – it does not require SWORD bindings for Python.</ref>

	'''Notes:'''		'''Notes:'''

Refdoc: /* ParaTExt (export to OSIS) */

2018-01-10T22:55:52Z

ParaTExt (export to OSIS)

← Older revision		Revision as of 22:55, 10 January 2018
Line 175:		Line 175:

	Checking \| Paratext 6 Checks \| Publishing \| Convert USFM to OSIS (Best Practice)		Checking \| Paratext 6 Checks \| Publishing \| Convert USFM to OSIS (Best Practice)

	~~:See [[Paratext to OSIS]] for illustration of this menu option.~~

	This option generates XML files with the following schema definition file referenced.		This option generates XML files with the following schema definition file referenced.

Refdoc at 15:32, 10 January 2018

2018-01-10T15:32:24Z

← Older revision		Revision as of 15:32, 10 January 2018
Line 101:		Line 101:

	==== Haiola ====		==== Haiola ====
	Michael Johnson's [http://haiola.org/ Haiola] Windows software includes the conversion from USFM to OSIS as one of its features. This software is used for making the Bible modules hosted at [[Module Repositories#eBible.org\|eBible.org]].		Michael Johnson's [http://haiola.org/ Haiola] Windows software includes the conversion from USFM to OSIS as one of its features. This software is used for making the Bible modules hosted at [[Official and Affiliated Module Repositories#eBible.org\|eBible.org]].

	=== usfm2osis.pl ===		=== usfm2osis.pl ===

Refdoc: /* Stage 2 */

2018-01-10T15:31:04Z

Stage 2

← Older revision		Revision as of 15:31, 10 January 2018
Line 240:		Line 240:
	# If cross references are part of the USFM files fix these with the help of <tt>xreffix.pl</tt> (also in sword-tools).<ref>This requires a sword locale in the local installation at least.</ref>		# If cross references are part of the USFM files fix these with the help of <tt>xreffix.pl</tt> (also in sword-tools).<ref>This requires a sword locale in the local installation at least.</ref>
	# Run again through <tt>osis2mod</tt> and check again.		# Run again through <tt>osis2mod</tt> and check again.
	# Submit the final OSIS file and the conf file to CrossWire together with the locale file.<ref>Include advice regarding which [[Module Repositories\|repository]] the module is intended for.</ref>		# Submit the final OSIS file and the conf file to CrossWire together with the locale file.<ref>Include advice regarding which [[Official and Affiliated Module Repositories\|repository]] the module is intended for.</ref>
	# Send any corrections on the USFM files back to the translation team. Chances are these are all valid and necessary corrections which help to improve the USFM.<ref>Both Paratext and Bibledit are a bit more forgiving than our tools, but some problems you encounter could have affected the final paper print.</ref>		# Send any corrections on the USFM files back to the translation team. Chances are these are all valid and necessary corrections which help to improve the USFM.<ref>Both Paratext and Bibledit are a bit more forgiving than our tools, but some problems you encounter could have affected the final paper print.</ref>

David Haslam: /* orefs.py */ Adyeths

2017-12-12T16:12:44Z

orefs.py: Adyeths

← Older revision		Revision as of 16:12, 12 December 2017
Line 150:		Line 150:

	===== orefs.py =====		===== orefs.py =====
	* Adyeths now has an ancillary script <tt>orefs.py</tt> to add the proper '''osisRef''' attribute to OSIS reference elements.<ref>This is fairly new (as of 2017-12-12) – it does not require SWORD bindings for Python.</ref>		* [[Converting SFM Bibles to OSIS#Adyeths\|Adyeths]] now has an ancillary script <tt>orefs.py</tt> to add the proper '''osisRef''' attribute to OSIS reference elements.<ref>This is fairly new (as of 2017-12-12) – it does not require SWORD bindings for Python.</ref>

	'''Notes:'''		'''Notes:'''

David Haslam: /* Cross-references */ original

2017-12-12T16:10:05Z

Cross-references: original

← Older revision		Revision as of 16:10, 12 December 2017
Line 147:		Line 147:

	==== Cross-references ====		==== Cross-references ====
	<tt>usfm2osis.py</tt> and <tt>usfm2osis.pl</tt> do not produce [[OSIS Bibles#Marking_cross-references_notes\|cross-references]] (or [[OSIS Bibles#Marking_parallel_passage_headings\|parallel passage headings]]) that work properly as links with SWORD.<ref>A solution for this is envisaged in the roadmap for <tt>usfm2osis.py</tt></ref> If your text contains such, you need <tt>xreffix.pl</tt> which sits in directory [https://crosswire.org/svn/sword-tools/trunk/modules/crossreferences/]. Using it requires the SWORD Perl bindings be installed and a [[DevTools:Locale Files\|sword-locale]]<ref>If the locale file has any errors or omissions, some references may end up with an incorrect osisRef. Thorough checking of the converted file is paramount.</ref> for the language of the module to be created.<ref>Special care is required when the cross-reference (or heading) includes additional text which is not a scripture reference. Until all these issues are fixed, it becomes almost impossible to parse the reference elements correctly such that the OSIS references can be added automatically.</ref>		<tt>usfm2osis.py</tt> and <tt>usfm2osis.pl</tt> do not produce [[OSIS Bibles#Marking_cross-references_notes\|cross-references]] (or [[OSIS Bibles#Marking_parallel_passage_headings\|parallel passage headings]]) that work properly as links with SWORD.<ref>A solution for this was envisaged in the original roadmap for <tt>usfm2osis.py</tt></ref> If your text contains such, you need <tt>xreffix.pl</tt> which sits in directory [https://crosswire.org/svn/sword-tools/trunk/modules/crossreferences/]. Using it requires the SWORD Perl bindings be installed and a [[DevTools:Locale Files\|sword-locale]]<ref>If the locale file has any errors or omissions, some references may end up with an incorrect osisRef. Thorough checking of the converted file is paramount.</ref> for the language of the module to be created.<ref>Special care is required when the cross-reference (or heading) includes additional text which is not a scripture reference. Until all these issues are fixed, it becomes almost impossible to parse the reference elements correctly such that the OSIS references can be added automatically.</ref>

	===== orefs.py =====		===== orefs.py =====

David Haslam: /* orefs.py */ Adyeths

2017-12-12T16:09:14Z

orefs.py: Adyeths

← Older revision		Revision as of 16:09, 12 December 2017
Line 150:		Line 150:

	===== orefs.py =====		===== orefs.py =====
	* ~~The developer of <tt>u2o.py</tt>~~ now has an ancillary script <tt>orefs.py</tt> to add the proper '''osisRef''' attribute to OSIS reference elements.<ref>This is fairly new (as of 2017-12-12) – it does not require SWORD bindings for Python.</ref>		* Adyeths now has an ancillary script <tt>orefs.py</tt> to add the proper '''osisRef''' attribute to OSIS reference elements.<ref>This is fairly new (as of 2017-12-12) – it does not require SWORD bindings for Python.</ref>

	'''Notes:'''		'''Notes:'''

David Haslam: /* Aydeths */ y

2017-12-12T16:08:28Z

Aydeths: y

← Older revision		Revision as of 16:08, 12 December 2017
Line 96:		Line 96:
	[https://github.com/johnaustindev/osis-converters osis-converters] is the location for the open source (U)SFM-to-OSIS and OSIS-to-SWORD module converters originally developed independently by the main programmer of [https://github.com/JohnAustinDev/xulsword xulsword]. He now uses his own maintained version of usfm2osis.py and has commit privilege to the one maintained for CrossWire by [[User:refdoc\|RefDoc]]. ''See above''.		[https://github.com/johnaustindev/osis-converters osis-converters] is the location for the open source (U)SFM-to-OSIS and OSIS-to-SWORD module converters originally developed independently by the main programmer of [https://github.com/JohnAustinDev/xulsword xulsword]. He now uses his own maintained version of usfm2osis.py and has commit privilege to the one maintained for CrossWire by [[User:refdoc\|RefDoc]]. ''See above''.

	==== ~~Aydeths~~ ====		==== Adyeths ====
	~~Aydeths~~ has developed a Python script that is ostensibly faster than CrossWire's usfm2osis.py<BR>		Adyeths has developed a Python 3 script that is ostensibly faster than CrossWire's usfm2osis.py<BR>
	Visit https://github.com/adyeths/u2o		Visit https://github.com/adyeths/u2o