Modules
  1. Modules
  2. MOD-189

TurNTB version 2.0 misplaced titles

    Details

      Description

      The recently released Turkish Bible module TurNTB has numerous misplaced titles.

      In every case, the titles are shifted to before the verse previous to where they should appear.

      The root cause lies in the CrossWire hosted script used for pre-processing from USFM to OSIS and the subsequent script to fix the titles by adding the the attribute subType="x=preverse".

      Because usfm2osis.pl locates the title elements before the eID milestone of the previous verse, the subsequent addition of the x-preverse attribute then causes them to be handled by SWORD or JSword for display before that verse.

      The solution would be to fix the usfm2osis.pl script such that after conversion of USFM title tags to OSIS, the XML title elements are also shifted to be located after the sID milestone for the verse they properly belong to. That would ensure that the subsequent addition of the x-preverse attribute would cause them to be displayed in the correct location.

      The simplest example that illustrates this issue is in Psalm 119, where all but one of the acrostic titles are misplaced.
      The worst example is for Psalm 18, which has multiple titles in the USFM file. These are all misplaced such that they appear before the last verse of Psalm 17.

      Seeing as the cause of this issue lies in the preprocessing scripts, it's conceivable that it also affects other modules that were prepared using the same tools.

        Activity

        Hide
        David Haslam added a comment -

        This issue highlights that the main cause of misplaced titles was where usfm2osis.pl places the verse eID milestones.

        From what I have already observed using usfm2osis.py - the same thing occurs.

        Verse eID milestones often appear too late, especially in relation to section titles.

        As a consequence, the transformations done by osis2mod cannot "reach" these titles.

        So module developers resorted to a kludge by running the now deprecated Perl script called title-cleanup.pl to add the argument subType="x-preverse" to some of the title elements.

        This should never have been necessary!

        According to Troy and others, it was NEVER INTENDED that module developers should need to add subType="x-preverse" as part of processing the OSIS XML files prior to using osis2mod.

        Doing so was an attempt to solve a problem by the wrong means.

        IMHO, this was because those doing so didn't really understand the true cause of the problem.

        The problem has not gone away.

        It affects nearly all attempts to make Bible modules starting from USFM source text.

        Show
        David Haslam added a comment - This issue highlights that the main cause of misplaced titles was where usfm2osis.pl places the verse eID milestones. From what I have already observed using usfm2osis.py - the same thing occurs. Verse eID milestones often appear too late, especially in relation to section titles. As a consequence, the transformations done by osis2mod cannot "reach" these titles. So module developers resorted to a kludge by running the now deprecated Perl script called title-cleanup.pl to add the argument subType="x-preverse" to some of the title elements. This should never have been necessary! According to Troy and others, it was NEVER INTENDED that module developers should need to add subType="x-preverse" as part of processing the OSIS XML files prior to using osis2mod. Doing so was an attempt to solve a problem by the wrong means. IMHO, this was because those doing so didn't really understand the true cause of the problem. The problem has not gone away. It affects nearly all attempts to make Bible modules starting from USFM source text.
        Hide
        David Haslam added a comment -

        In December 2011, I tried to persuade refdoc that the TurNTB module should not have been released until this issue was fixed.

        He persuaded me (against my better judgement) by arguing that it were better to release soon, and make the Turkish Bible available electronically, and fix any such issues asap after release.

        I vainly imagined then that such issues would have been speedily diagnosed and fixed early in 2012.

        That this issue is still open after a further 18 months is a very serious concern.

        Show
        David Haslam added a comment - In December 2011, I tried to persuade refdoc that the TurNTB module should not have been released until this issue was fixed. He persuaded me (against my better judgement) by arguing that it were better to release soon, and make the Turkish Bible available electronically, and fix any such issues asap after release. I vainly imagined then that such issues would have been speedily diagnosed and fixed early in 2012. That this issue is still open after a further 18 months is a very serious concern.
        Hide
        Chris Little added a comment -

        I don't see a submission of anything. Perhaps you sent it to my personal address. You can find module submission instructions at http://www.crosswire.org/wiki/DevTools:Modules#Submit_the_Module_to_the_SWORD_Project_for_Distribution .

        Show
        Chris Little added a comment - I don't see a submission of anything. Perhaps you sent it to my personal address. You can find module submission instructions at http://www.crosswire.org/wiki/DevTools:Modules#Submit_the_Module_to_the_SWORD_Project_for_Distribution .
        Hide
        David Haslam added a comment -

        I am unable to submit a new module for the same reasons as reported earlier.

        The USFM files are correct.

        The OSIS file generated by usfm2osis.pl was wrong in Dec 2011 and is still wrong.
        The OSIS file generated by usfm2osis.py is also still wrong.

        With either script, some verse eID milestones are not in the right place.

        Please look back at what I have written in detail.

        Using the existing script usfm2osis.py it is impossible to fix the main underlying issue!

        IMHO, there is a serious software design issue underlying Bible module development problems.
        I have been repeatedly reporting this, but no-one seems to be listening.

        How can I proceed to the next step (using osis2mod)
        while the conversion scripts provided by CrossWire give the wrong output?

        Show
        David Haslam added a comment - I am unable to submit a new module for the same reasons as reported earlier. The USFM files are correct. The OSIS file generated by usfm2osis.pl was wrong in Dec 2011 and is still wrong. The OSIS file generated by usfm2osis.py is also still wrong. With either script, some verse eID milestones are not in the right place. Please look back at what I have written in detail. Using the existing script usfm2osis.py it is impossible to fix the main underlying issue! IMHO, there is a serious software design issue underlying Bible module development problems. I have been repeatedly reporting this, but no-one seems to be listening. How can I proceed to the next step (using osis2mod) while the conversion scripts provided by CrossWire give the wrong output?
        Hide
        David Haslam added a comment - - edited
        Show
        David Haslam added a comment - - edited See new issue http://www.crosswire.org/tracker/browse/MODTOOLS-57

          People

          • Assignee:
            David Haslam
            Reporter:
            David Haslam
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated: