Talk:Converting SFM Bibles to OSIS - Revision history

David Haslam: /* usfm2osis.py moved to github */ new section

2014-12-30T10:02:39Z

‎usfm2osis.py moved to github: new section

David Haslam: /* Nested tags */ new section

2013-05-18T11:09:43Z

‎Nested tags: new section

David Haslam: /* Removed subsections */

2013-05-18T10:48:22Z

‎Removed subsections

David Haslam: /* Removed subsections */ new section

2013-05-18T10:43:15Z

‎Removed subsections: new section

David Haslam: /* Module creation process - improving this section */ new section

2013-05-17T12:56:51Z

‎Module creation process - improving this section: new section

David Haslam: /* Haiola? */ new section

2013-05-08T07:50:55Z

‎Haiola?: new section

David Haslam: /* The Every Tribe Every Nation initiative */ new section

2012-04-23T07:25:06Z

‎The Every Tribe Every Nation initiative: new section

David Haslam: /* checkbible ? */ ::See http://xmlsoft.org/xmllint.html ~~~~

2012-01-14T16:58:55Z

‎checkbible ?: ::See http://xmlsoft.org/xmllint.html ~~~~

David Haslam: /* checkbible ? */ :At a guess, it's the name of a script file that calls `xmllint` with command line parameters supplied to validate the specified OSIS XML file against the schema. ~~~~

2012-01-14T16:56:18Z

‎checkbible ?: :At a guess, it's the name of a script file that calls <tt>xmllint</tt> with command line parameters supplied to validate the specified OSIS XML file against the schema. ~~~~

David Haslam: /* checkbible ? */ new section

2012-01-14T16:51:08Z

‎checkbible ?: new section

← Older revision		Revision as of 10:02, 30 December 2014
Line 140:		Line 140:
	00122 \+tl* Transliterated (or foreign) word[s] end (nested)		00122 \+tl* Transliterated (or foreign) word[s] end (nested)
	</pre>		</pre>
		+
		+	== usfm2osis.py moved to github ==
		+
		+	[[User:Osk\|Osk]] moved development to GitHub in April: https://github.com/chrislit/usfm2osis
		+	[[User:David Haslam\|David Haslam]] 03:02, 30 December 2014 (MST)

← Older revision		Revision as of 11:09, 18 May 2013
Line 122:		Line 122:
	'''Notes:'''		'''Notes:'''
	<references />		<references />
		+
		+	== Nested tags ==
		+
		+	These (as yet undocumented) 'nested' USFM tags were encountered in the source files for the complete Welsh Beibl project (2013). [[User:David Haslam\|David Haslam]] 05:09, 18 May 2013 (MDT)
		+	<pre>
		+	Count SFM tag Description
		+	----- -------------------
		+	00004 \+it Italics text style begin (nested)
		+	00004 \+it* Italics text style end (nested)
		+	00026 \+nd Name of deity begin (nested)
		+	00026 \+nd* Name of deity end (nested)
		+	00003 \+qt Quoted text begin (nested)
		+	00003 \+qt* Quoted text end (nested)
		+	00206 \+sc Small-cap text begin (nested)
		+	00206 \+sc* Small-cap text end (nested)
		+	00122 \+tl Transliterated (or foreign) word[s] begin (nested)
		+	00122 \+tl* Transliterated (or foreign) word[s] end (nested)
		+	</pre>

← Older revision		Revision as of 10:48, 18 May 2013
Line 92:		Line 92:

	I just removed these two subsections that were misleading developers. [[User:David Haslam\|David Haslam]] 04:43, 18 May 2013 (MDT)		I just removed these two subsections that were misleading developers. [[User:David Haslam\|David Haslam]] 04:43, 18 May 2013 (MDT)
		+
		+	:Scribe wrote in sword devel...
		+	::Please forget about x-preverse. It was never intended for module developers. It is an internal attribute we add to help the SWORD engine process OSIS. Brief overview without details: SWORD must keep all data in 'verse' chunks. Hence, the title for a verse goes WITHIN the verse chunk and we need to mark it somehow that it was really meant be be rendered 'pre-verse'. This should never be known to anyone but a developer of the internals of the SWORD engine.
		+	::I realize it was added manual by module developers to pragmatically get titles to display how they wished when their markup was not showing properly because their titles were not getting the x-preverse tag added by osis2mod. This was the wrong long-term solution (though I don't need to be lectured on WHY it was used by module developers; I sympathize that you just wanted to get something working). The correct solution is 2 fold: to use correct OSIS and make sure osis2mod "Does The Right Thing"(tm).
		+	:[[User:David Haslam\|David Haslam]] 04:48, 18 May 2013 (MDT)

	==== Titles ====		==== Titles ====

← Older revision		Revision as of 10:43, 18 May 2013
Line 88:		Line 88:

	Need to replace all the references to '''usfm2osis.pl''' by '''usfm2osis.py''', making further changes as and where required. [[User:David Haslam\|David Haslam]] 06:56, 17 May 2013 (MDT)		Need to replace all the references to '''usfm2osis.pl''' by '''usfm2osis.py''', making further changes as and where required. [[User:David Haslam\|David Haslam]] 06:56, 17 May 2013 (MDT)
		+
		+	== Removed subsections ==
		+
		+	I just removed these two subsections that were misleading developers. [[User:David Haslam\|David Haslam]] 04:43, 18 May 2013 (MDT)
		+
		+	==== Titles ====
		+	Unfortunately, (right now) from such a generated OSIS file, the next step via osis2mod does not ensure that certain titles display correctly with SWORD.<ref>The main issue as regards whether titles are displayed by any front-end seems to be for titles at the start of a chapter.</ref><ref>Modules made from OSIS files generated by usfm2osis.py do display titles when they are not at the start of a chapter, and they are in the right position.</ref>
		+
		+	A further perl script, <tt>title-cleanup.pl</tt> may be used (with care) to add the argument <tt>subType="x-preverse"</tt> to some titles.<ref>This attribute should only be used when the title element is placed within the verse. As it stands, <tt>title-cleanup.pl</tt> does not restrict the changes to this pattern.</ref><ref>We have encountered a few modules in which this script has been mistakenly applied where it was unnecessary. The effect has been to misplace some titles to above the verse prior to the one they should be displayed as headings for. In some cases, this shifted the titles to before the last verse of the previous chapter!</ref><ref>There is still an unsolved issue that caused some preverse titles to be misplaced in '''TurNTB''' version 2.0. The symptoms are described in [http://www.crosswire.org/bugs/browse/MOD-189 modules issue 189].</ref>
		+
		+	'''Notes:'''
		+	<references />
		+
		+	==== New lines ====
		+	usfm2osis.py does not insert a new line above each section title. That shouldn't have mattered, but SWORD mysteriously appends the title text to the end of the previous verse text. The following workaround should fix this, but the replacements should be restricted to titles other than those at the start of a chapter.
		+
		+	Replace
		+	<pre>
		+	<div type="section"><title
		+	</pre>
		+	by
		+	<pre>
		+	<div type="section"><p></p>
		+	<title
		+	</pre>
		+	using any compatible text editor.<ref>The omission of the ">" for the title element was just in case any of these had an attribute.</ref><ref>Similar workarounds are required for other kinds of title (such as acrostic stanza headings).</ref><ref>Care must be taken to ensure that the XML remains valid.</ref>
		+
		+	'''Notes:'''
		+	<references />

← Older revision		Revision as of 12:56, 17 May 2013
Line 84:		Line 84:
	Should we include anything about Michael Johnson's [http://haiola.org/ Haiola Scripture Publishing Software]?		Should we include anything about Michael Johnson's [http://haiola.org/ Haiola Scripture Publishing Software]?
	[[User:David Haslam\|David Haslam]] 01:50, 8 May 2013 (MDT)		[[User:David Haslam\|David Haslam]] 01:50, 8 May 2013 (MDT)
		+
		+	== Module creation process - improving this section ==
		+
		+	Need to replace all the references to '''usfm2osis.pl''' by '''usfm2osis.py''', making further changes as and where required. [[User:David Haslam\|David Haslam]] 06:56, 17 May 2013 (MDT)

← Older revision		Revision as of 07:50, 8 May 2013
Line 79:		Line 79:

	As there is a real prospect for CrossWire to eventually become an approved End-User-Ministry-Partner (EUMP) within the framework of the [http://everytribeeverynation.org/ Every Tribe Every Nation] initiative, it makes good sense to gain a better knowledge of how UBS & SIL are using OSIS. This is why I have just added further details about the OSIS files exported from Paratext. We need to learn more. [[User:David Haslam\|David Haslam]] 01:25, 23 April 2012 (MDT)		As there is a real prospect for CrossWire to eventually become an approved End-User-Ministry-Partner (EUMP) within the framework of the [http://everytribeeverynation.org/ Every Tribe Every Nation] initiative, it makes good sense to gain a better knowledge of how UBS & SIL are using OSIS. This is why I have just added further details about the OSIS files exported from Paratext. We need to learn more. [[User:David Haslam\|David Haslam]] 01:25, 23 April 2012 (MDT)
		+
		+	== Haiola? ==
		+
		+	Should we include anything about Michael Johnson's [http://haiola.org/ Haiola Scripture Publishing Software]?
		+	[[User:David Haslam\|David Haslam]] 01:50, 8 May 2013 (MDT)

← Older revision		Revision as of 07:25, 23 April 2012
Line 75:		Line 75:

	::See http://xmlsoft.org/xmllint.html [[User:David Haslam\|David Haslam]] 09:58, 14 January 2012 (MST)		::See http://xmlsoft.org/xmllint.html [[User:David Haslam\|David Haslam]] 09:58, 14 January 2012 (MST)
		+
		+	== The Every Tribe Every Nation initiative ==
		+
		+	As there is a real prospect for CrossWire to eventually become an approved End-User-Ministry-Partner (EUMP) within the framework of the [http://everytribeeverynation.org/ Every Tribe Every Nation] initiative, it makes good sense to gain a better knowledge of how UBS & SIL are using OSIS. This is why I have just added further details about the OSIS files exported from Paratext. We need to learn more. [[User:David Haslam\|David Haslam]] 01:25, 23 April 2012 (MDT)

← Older revision		Revision as of 16:58, 14 January 2012
Line 73:		Line 73:

	:At a guess, it's the name of a script file that calls <tt>xmllint</tt> with command line parameters supplied to validate the specified OSIS XML file against the schema. [[User:David Haslam\|David Haslam]] 09:56, 14 January 2012 (MST)		:At a guess, it's the name of a script file that calls <tt>xmllint</tt> with command line parameters supplied to validate the specified OSIS XML file against the schema. [[User:David Haslam\|David Haslam]] 09:56, 14 January 2012 (MST)
		+
		+	::See http://xmlsoft.org/xmllint.html [[User:David Haslam\|David Haslam]] 09:58, 14 January 2012 (MST)

← Older revision		Revision as of 16:56, 14 January 2012
Line 71:		Line 71:

	In Stage 1, the command <tt>checkbible</tt> is generally unknown and requires explaining. [[User:David Haslam\|David Haslam]] 09:51, 14 January 2012 (MST)		In Stage 1, the command <tt>checkbible</tt> is generally unknown and requires explaining. [[User:David Haslam\|David Haslam]] 09:51, 14 January 2012 (MST)
		+
		+	:At a guess, it's the name of a script file that calls <tt>xmllint</tt> with command line parameters supplied to validate the specified OSIS XML file against the schema. [[User:David Haslam\|David Haslam]] 09:56, 14 January 2012 (MST)

← Older revision		Revision as of 16:51, 14 January 2012
Line 67:		Line 67:

	Next, update the ''run.bat'' file that came with SFMToOSIS to point to your SFM files and SSF file. Then run ''run.bat''.		Next, update the ''run.bat'' file that came with SFMToOSIS to point to your SFM files and SSF file. Then run ''run.bat''.
		+
		+	== checkbible ? ==
		+
		+	In Stage 1, the command <tt>checkbible</tt> is generally unknown and requires explaining. [[User:David Haslam\|David Haslam]] 09:51, 14 January 2012 (MST)