Talk:Modules in the beta repository
From CrossWire Bible Society
I thought I'd move discussion about the implementation of modules here. It was cluttering the other page and when we'd get a new version or address a problem, we'd reset the row. Here we can keep the info until we are done.--Dmsmith 05:35, 22 June 2008 (MDT)
- Talk pages are intended for discussing how to improve the wiki page, not as a forum for discussing the topic it covers. David Haslam 21:56, 21 February 2009 (UTC)
- It's probably best if we keep non-talk pages largely free of discussion and try to keep them clean so that they can be good reference pages for whenever we need to look details up. So all discussion should probably be kept to either talk pages or mailing lists--and preferably the latter except in the case of collaborative whiteboarding like we have here.... That is to say, this is still not Wikipedia, Wikis were not invented by Jimbo & Co., and there's no good reason for which we should limit ourselves to Wikipedia style. --Osk 03:19, 23 February 2009 (UTC)
In Matt 5 there is a WoC display problem. The WoC has a start in verse 3 and ends at the end of the last chapter. Fortunately, the WoC start and finish in this module is on chapter boundaries. If it had started in chapter 5 and finished in chapter 7 then the display of chapter 6 would never highlight the WoC.
The SWORD Engine currently terminates WoC at a verse boundary, regardless of how it is encoded. This is because it does not keep state regarding WoC across a single verse. No frontend will display it correctly, because it is not a frontend problem.
I (DM) see several solutions (there may be others):
- Change osis2mod to accept a wider range of valid OSIS inputs, creating a module that the SWORD Engine can handle, specifically allowing how this is encoded. Then it can work with 1.5.9.
- Change the SWORD engine to handle this input at a chapter level. This is not a complete solution. Currently, when the KJV is searched, the WoC are highlighted in the search results list. This input will only highlight Matt 5:3 for any hit in Matt 5. Changing the SWORD Engine will require this module to be 1.5.12.
- Change the module so that it is encoded as recommended in the wiki for OSIS Bibles. Then it can work with 1.5.9
The easiest is to change the module. If not that, I'd suggest changing osis2mod, which probably is the best solution, resulting in easier module definition. I don't like the SWORD Engine change, because it is incomplete.
- It looks to me as if it doesn't really matter how I encode the text, it won't render correctly on some set of frontends. <q>...</q> was the original encoding, and that got complaints, so I switched to milestoned <q sID/>...<q eID/> encoding (1.2), and that got more complaints, so I switched back to containers (1.3). Play with both. Tell me which is less wrong. Osk 14:03, 21 June 2008 (MDT)
There have been 3 versions:
The version 1.1 had for Matt 5:3-4:
(Note: my comment on this was that the sIDs and the eIDs were not properly encoded.)
5.3: <q marker="" sID="q1" who="Jesus"/><br/> Happy the poor in spirit; for theirs is the kingdom of heaven. <q eID="q1++" marker="" who="Jesus"/> 5.4: <q marker="" sID="q1" who="Jesus"/> Happy they that mourn; for they shall be comforted. <q eID="q1++" marker="" who="Jesus"/>
Version 1.2 has:
5.3: <q marker="" who="Jesus" sID="q7"/> Happy the poor in spirit; for theirs is the kingdom of heaven. 5.4: Happy they that mourn; for they shall be comforted.
Version 1.3 has:
<q marker="" who="Jesus"> Happy the poor in spirit; for theirs is the kingdom of heaven. 5.4: Happy they that mourn; for they shall be comforted.
Of the above, 1.1 is in my opinion, the best. It can work in the search result.
The following variant of 1.1 will work for all frontends and given how simple the ABU is, it should produce well-formed valid XML. The way to think about this is that <q marker="" who="Jesus"> is not a quotation marker but is a WoC marker as in <woc>...</woc> that has to be started and stopped in each verse and surround each word/phrase that Jesus uttered.
5.3: <q marker="" who="Jesus"> Happy the poor in spirit; for theirs is the kingdom of heaven. </q> 5.4: <q marker="" who="Jesus"> Happy they that mourn; for they shall be comforted. </q>
Dmsmith 19:14, 21 June 2008 (MDT)
There's some confusion here.
- 1.0 was encoded with <q>...</q>.
- 1.1 was encoded with <q sID="q1"/>...<q eID="q1++"/>. That was just a bug in that I forgot to execute the ++ expression, so it got copied into the text. If I ever did <q>...</q> in a way that was contained within the verse, it was probably at this stage and was an error stemming from the ++ execution bug.
- 1.2 just executed the ++ interator, so it has <q sID="q1"/>...<q eID="q1"/> and iterates the number.
- 1.3 goes back to 1.0 (it's quite possibly bit-for-bit identical) with <q>...</q>.
- ABU_1_2 is identical to 1.2 because it is literally the same files. I just moved the directory on the server from ABU to ABU_1_2 before uploading the new version.
- Whenever <q/> milestones are used, <verse/> appears as a container, and vice versa.
- The basic hierarchy of OSIS Bibles is Book-Section-Paragraph rather than Book-Chapter-Verse. We asked SIL/Wycliffe (and maybe some UBS guys); they said use BSP, not BCV. We chose to prefer BSP. That's why <div/> and <p/> (the BSP hierarchy elements) aren't milestonable but <chapter/> and <verse/> are.
Osk 22:35, 21 June 2008 (MDT)
OK, I've got my numbers off. The version that had q++, I thought was 1.2. I guess I never saw 1.2. I've corrected my statement above to your information.
Regarding your comment about BCV, the <div> element is milestoneable.
If BSP is the proper way to encode an OSIS Bible, then I think:
- <verse> should always be milesoned.
- osis2mod should preserve the verse element (start and end) in the text and get rid of the pre-verse hack. With BSP, this will occur more and more.
Whether we encode OSIS Bible texts as BCV or BSP, the resulting module needs to work for Bible applications. In the SWORD engine verse is the indexable unit in the SWORD engine. All of our applications display verses in isolation, at least in the search result, some elsewhere.
I think the following is the best short term solution (which is a minor variation of 1.1):
- If quotation marks are to be displayed in the module, mark the beginning of the quote in chapter 5 with <q sID="xxx"/>, and the end of the quote in Matt 7 with <q eID="yyy"/>. Add marker attribute to be UTF-8 curly quotes if desired. Also, if the quote is interrupted, such that quotation marks should appear in the span of the Sermon on the Mount, then put the same there.
If quotations are not needed then these are entirely unnecessary for our code as it stands today, but they might come in handy if we had each quote in the scripture marked with who as we could analyze the text for who said what.
- Within each verse surround the actual words of Christ with <woc>...</woc>. Obviously, if these cross a BSP boundary, then they stop and start on either side of the boundary. Finally, to make valid OSIS replace those with <q who="Jesus" marker=""> and </q> respectively. The milestoned version (i.e. your 1.1) should have worked for all SWORD apps as of 1.5.9. But it didn't.
It does not work for JSword because it uses xslt to do the processing, which cannot handle it.
- If the module should not show quote marks, use OSISQToTick=false (From memory. So, I may have goofed this.) This makes the empty marker="" unnecessary.
Ultimately, it is the responsibility of osis2mod to placate the SWORD Engine by transforming modules to what it wants to hear. I think the best long term solution is for osis2mod to handle all properly encoded documents, such as 1.2 and 1.3. (Version 1.1 was a placation.) Obviously, if one can tediously encode 1.1, that processing can be put into osis2mod.
Dmsmith 05:35, 22 June 2008 (MDT)
One of the longstanding principles of our employment of OSIS has been that we should accept any valid OSIS, but that we need not maintain valid OSIS in our data. So osis2mod should accept anything that is valid, but the contents of the modules themselves need not be valid OSIS. (I'm more concerned with actual markup here. The cases where people actually want to use UTF-16 encoded OSIS or single quotes instead of double in attribute values aren't significant enough for me to care.)
- <verse> should generally be the first element that gets milestoned any time there is a well-formedness problem. The purpose for allowing both milestoned and container forms was to allow simply Bibles to be encoded simply.
- I agree that <verse> elements should be preserved. That's why I made the change, committed it, and posted a Bible or two using this format. Troy had objections and rolled back the changes, though they had no negative effects on any existing or future content. If you want to pursue this, talk to Troy. I see not preserving <verse> as universally bad. I don't see any problem with maintaining the pre-verse title system.
- There should be no problem with using marker="". This is actual OSIS, whereas OSISQToTick=false was added to handle OSIS docs that don't actually conform to the standard. The marker attribute came in one of the last OSIS releases (2.1 or 2.1.1) and solved (in a more official capacity) a problem for which we had developed a hack (OSISQToTick). If we're concerned with accepting any valid OSIS, we should definitely accept marker="" and should probably deprecate OSISQToTick.
We should probably define a non-standard method of encoding <q> that fits within <verse> elements but that can be easily derived (by osis2mod) from either standard, valid encoding. I suspect we should just use <q/> (though <milestone/> is another possibility). Given the following input:
<verse> cdata <q osisID="q1" sID="q1" who="Jesus" marker=""/> cdata </verse> <verse> cdata <q osisID="q1" eID="q1" who="Jesus" marker=""/> cdata </verse>
We could generate:
<verse> cdata <q osisID="q1" sID="q1" who="Jesus" marker=""/> cdata <q type="x-continuation" eID="" who="Jesus" marker=""/> </verse> <verse> <q type="x-continuation" sID="" who="Jesus" marker=""/> cdata <q osisID="q1" eID="q1" who="Jesus" marker=""/> cdata </verse>
And given the following input:
<verse sID="v1"/> cdata <q osisID="q1" who="Jesus" marker=""> cdata <verse eID="v1"/> <verse sID="v2"/> cdata </q> cdata <verse eID="v2"/>
We could generate:
<verse sID="v1"/> cdata <q osisID="q1" who="Jesus" marker=""> cdata <q type="x-continuation" eID="" who="Jesus" marker=""/> <verse eID="v1"/> <verse sID="v2"/> <q type="x-continuation" sID="" who="Jesus" marker=""/> cdata </q> cdata <verse eID="v2"/>
I believe these will validate as OSIS and would work in BibleCS without modification. I suspect they will work in HTMLHREF frontends with little (if any) modification, but I haven't looked at the code lately. It seems to me that XSLT ought to be able to convert milestone elements to container element starts/ends for JSword, but I haven't touched XSLT in about 6 years.
Osk 20:49, 26 June 2008 (MDT)
I think we agree that osis2mod is the proper place to solve the problem and I think we agree on what osis2mod should accept. While I am not overly concerned whether the resulting OSIS is valid, I'd caveat that by saying that each element and attribute should be valid defined in OSIS.
In my opinion, osis2mod should mark up the text in such a way that we know what is created by osis2mod. That way we can reasonably reconstruct the original. We can use x- attribute values to type and subType for this purpose. In this example, the start and end of the Sermon on the Mount could be marked as original, with x-start and x-end.
Currently the milestoned version of the WoC is not handled by MS, GS or BD. That it is handled by SW indicates that the problem may be in MS or GS not using the HTMLHREF filter or that there is a minor difference between it and what SW actually uses. BD is altogether a different issue. The point is that a filter change is a 1.5.12 change.
We have a couple of choices in changing osis2mod (as discussed above):
- Change it to produce <q> as a container. This is how ESV and KJV are encoded and it works with 1.5.9 and with JSword/BD.
- Change it to produce <q> as a milestone and also fix HTMLHREF to accept it and not release the modules until 1.5.12 is released. I might be able to figure out how to get JSword/BD to handle it.
In both of these the location of the start and end markers are the same. The difference is the form.
Regarding XSLT, the guarantee of XSLT is that all output is well-formed. I have not found a way to specify the output a begin element without also outputting an end element. The processing that is necessary is to collect the content and elements between two arbitrary points (represented by milestones) and style it. I simply don't know how to do it or whether it can be done, let alone whether it can perform well.
I may be able to pre-filter and do a transformation.
On a different note: Regarding the inclusion of <verse> and the pre-verse handling:
Right now the pre-verse handling is solely for the sake of headings. These are pulled out of the stream and stored as verse heading attributes. It cannot handle other kinds of pre-verse content, such as white-space (e.g. new lines) and notes.
With regard to whitespace before a verse, generally it is appended to the prior verse. If it occurs after the heading, osis2mod yanks it and treats it as if it came before the heading.
With regard to notes it is perfectly valid OSIS to have a note attached to a heading by immediately following it. SWORD cannot handle it. One way to handle it is for osis2mod to move the note into the heading. There used to be a problem with having notes in a heading, but it may be fixed now.
--Dmsmith 08:46, 27 June 2008 (MDT)
I don't really care about whether we can release ABU (and KJC or any other modules that use <q/> in the current lineup) for 1.5.11. If there are quirks or incompatibilities, we should figure out a way to fix them, implement them as necessary (in the module, in the importer, and in the library), and then release ABU, etc. I think there are ample grounds for doing all of the minor updates to filters (TEI stuff, OSISRuby, whatever is necessary for words of Christ, etc.) and releasing 1.5.12 with just that much improvement.Osk 18:32, 30 June 2008 (MDT)
Works for me. I'd be happy to work on osis2mod. If you get to it before me, that's OK too. I think we should wait a bit to see what we decide on how to handle the Wycliffe modules. Specifically, all the pre-verse stuff; whether we should change container elements to milestones; and whether we leave in the verse elements (converted to milestones, too). --Dmsmith 20:37, 30 June 2008 (MDT)
The printing of the words of Christ in red was developed around 1900. No Bible (Including the 1769 KJV) had Christ's words marked in red prior to then.
Because the KJV 1769 is the edition that WoC red letter was first applied to, and the marks are now almost universally accepted as the intention of the translators in 1611, it's hard to argue against WOC being marked up in the KJV. However, applying circa 1900 WOC mark ups to earlier editions that don't have the words of Christ marked up at all clearly is, in my opinion, revising the edition. Editions so processed should be released as contemporary updates to those editions, not the original. At least the fact that WOC is a later update should be mentioned in the conf file.
Why? In the mid to late 1800's there was discussion on exactly which words in the Bible were Christ's. Some editions did go to great lengths to quotify or boldify the words of Christ, but not all of them agreed with the red words marked in the KJV. See Farrar Fenton's "Modern English Bible" John Chapter 3, where Fenton goes so far as to put a section heading IN text stating that the words of Christ STOP at John 3:15.. John 3:16-21 is marked 'commentary by the Evangelist'.
Other editions (such as the ABS 1911) intentionally left the interpretation of scripture to the reader. While I don't have the 1865 ABU edition at hand, the Later ABU and 1911 ABS editions based on this edition have no quotation marks or any indication exactly where the words of Christ start or stop.
To correctly represent the translation, keeping the same mark up (OR LACK OF) is the duty of the one doing the digitization.
When I turn OFF the WOC for pre-1900 editions, I'd expect quote marks that didn't exist in the original editions to disappear. Also, If quote marks did exist in the 1865 edition, I'd expect them to remain whether or not the text is painted red. (That is, the translator's intended meaning clearly depends on the quote marks.) Changing the color should be able to toggle, but adding/removing quote marks makes the edition useless for study of exactly what the translator intended. Mikey 22:38, 18 January 2009 (UTC)
Abbreviations now that GnomeSword is renamed as Xiphos?
Any thoughts on where we go regarding the GS abbreviation, following the release of Xiphos (formerly known as GnomeSword)? David Haslam 11:29, 14 February 2009 (UTC)
- No-one else suggested one, so I have plumbed for XP as the abbreviation. David Haslam 21:53, 21 February 2009 (UTC)
- I don't think that continuing to use GS will confuse anyone. Using XP will confuse most people most of the time. Likewise for X. --Osk 03:03, 23 February 2009 (UTC)
Table column width
The table in the Beta Dictionary Modules section now has a very wide column for Encoding problems, as a result of a recent edit. Most users find horizontal scrolling in wiki pages a PITB. Please come up with an improvement to how the new information is presented. David Haslam 11:08, 27 March 2009 (UTC)
- This annoyance has not yet been addressed. David Haslam 09:23, 19 September 2009 (UTC)
The problem was the <pre> block (which I changed to use < and a wiki-style leading space.) These will not wrap. Probably the best thing to do would be put quote in a <ref> so that it would go below the table. Instead, I reformatted the blocks to be narrower. It doesn't scroll on my wide laptop screen. --Dmsmith 22:37, 1 November 2009 (UTC)
- Solved indeed! Thanks. David Haslam 15:18, 2 November 2009 (UTC)
- While examining KJC module, after having done searches in Rotherham for "\ul0" and for "\ul1", I observed that some blue link boxes to these two search results (Topic tags) had appeared in several places within the KJC text. Example: just above Mat 5:33.
- I'm guessing this is because you saved the search results. If you have problems like these, probably the BPBible forums are the best place to ask about it (http://bpbible.com/forums) Benpmorgan 23:58, 16 June 2009 (UTC)
- Yes - I had saved the search results while using the Rotherham. Initially there was no mental connection for me to the phrase "Topic Tags" in the menu options. It took me some time to figure what was happening. David Haslam 12:29, 17 June 2009 (UTC)
Henry Tomkins Anderson's New Testament
The Anderson NT scanned text in the Internet Archive has multiple OCR errors. These require checking and correcting against a printed book, either a library copy of the original 1865 or subsequent edition, or a modern reprint.
The British Library has one copy of the 1867 edition.
A search of http://www.worldcat.org/ found that the Cincinnati, Standard Pub. Co. [©1918] edition is held in several academic libraries in the USA. The New Testament, tr. from the Sinaitic manuscript discovered by Constantine Tischendorf at Mt. Sinai. OCLC Number: 3755626.
A search of http://www.abebooks.co.uk/ found that the Anderson NT 1865 is available as a print-on-demand paperback. ISBN: 1418188247 / 1-4181-8824-7. Scholarly Publishing Office, University of Michigan Library, 2006.
David Haslam 20:06, 15 August 2009 (UTC)
- I have just ordered a copy of the 2006 reprint from a reputable UK bookseller (in stock) via Amazon. David Haslam 20:27, 15 August 2009 (UTC)
- It is based on the 1918 edition. David Haslam 20:41, 15 August 2009 (UTC)
- The book was delivered during August. It's a facsimile edition. Text area is 69mm x 111mm, centred on pages 135mm x 234mm. David Haslam 09:22, 19 September 2009 (UTC)
The most notable and idiosyncratic OCR (or spell-check) error in the CrossWire beta module is surely this one in Acts 16:37, "But Paul said to them: Having publicly scourged us uncondemned, us who are Etonians, they threw us into prison: and do they now put us out secretly? No, verily: but let them come and lead us out."
Hmmmm.... I never knew Saint Paul went to Eton College ! David Haslam 14:49, 17 August 2009 (UTC)
- I may have confused Anderson's 1865 translation from the Greek text with a much later Anderson translation (1918) based on the Sinaitic MS. These are two different translations, being translations of different Greek texts. David Haslam 12:21, 25 May 2011 (MDT)
Different abbreviation used here for BibleCS than in Choosing a SWORD program
An annoying inconsistency that tripped me up during the last few edits! Choosing a SWORD program uses SPW as the abbreviation for The SWORD Project for Windows. This page uses BibleCS. David Haslam 14:37, 29 October 2009 (UTC)
Modules not now in CrossWire Beta
By using the Bible Desktop or Xiphos UIs, one can easily view the modules currently in CrossWire Beta. Some of those that were listed in the main page must have been removed. I have started this section in order to cut'n'paste the table rows for those modules no longer visible in CrossWire Beta. David Haslam 16:22, 9 December 2010 (UTC)
Tables sorted and dates added
I have also sorted each Bibles table in module name order, and added the SwordVersionDate to modules for which this was missing. David Haslam 17:08, 9 December 2010 (UTC)
Strictly speaking, CrossWire experimental modules are not in the beta repository. I have left these in this page for the time being, rather than moving them to a new wiki page. However, I have restructured the page to make this more apparent. David Haslam 19:40, 9 December 2010 (UTC)
- Nevertheless, this section is now totally out of date, as there are far more modules in CrossWire Experimental than listed here. A separate page is therefore warranted. David Haslam 19:52, 9 December 2010 (UTC)
The number of beta modules on the main page
Providing every module name is a link (wiki or external), the number of beta modules listed in the main page can be found be editing the section called Beta Modules, select all and copy (to a new file) in Notepad++, then use its Find Dialog to count the occurrences of "|[". When I did this today, there were 105 matches, so the the discrepancy is that 4 modules are not yet tabulated here. David Haslam 20:06, 9 December 2010 (UTC)
- The actual number of modules in a repository is displayed in the JSword books manager, as used in BD. David Haslam 20:21, 9 December 2010 (UTC)
The Translation Trust
Page and Talk Page Deletions
I'm trying to pare down the text on the 'Modules in the beta repository' page, as well as on the talk page and the contents of the beta repository itself. Ultimately, I'd like to delete the whole repository and its associated wiki pages as soon as possible, either by fixing & re-releasing content, moving it to the main repository, or moving it to the experimental repository. So information on former beta modules and entries on the talk page will be deleted (however gradually) as I get around to each individual module. When the repository is entirely empty, I'll delete the page. --Osk 01:52, 3 January 2013 (MST)
Polish Uwspółcześniona Biblia Gdańska (Gate of Hope Foundation)
Despite the fact that an OSIS file was submitted in October 2010, it appears that a module update was not progressed. We now have opportunity to start afresh from the 2013 Edition and to include Psalms & Proverbs along with the NT books.David Haslam 10:21, 28 May 2013 (MDT)
Now that KJV module version 2.5 has been released in CrossWire Main, is it time to remove KJV version 2.3 from CrossWire Beta? Have all the issues been fixed? David Haslam 07:08, 23 October 2013 (MDT)