refdoc / Module-tools

Scripts and tools for SWORD module conversions
5 stars 3 forks source link

Please swap the order of osisID and sID in chapter and verse start milestones #4

Open DavidHaslam opened 7 years ago

DavidHaslam commented 7 years ago

Having the osisID attribute before the sID attribute in start milestones is not what we specify in the SWORD developers' wiki page OSIS Bibles.

When the output XML file is pretty print reformated, it's much more readable when the verse sID and verse eID milestones are vertically aligned.

Currently we see:

            <chapter osisID="Gen.1" sID="Gen.1"/>
            <verse osisID="Gen.1.1" sID="Gen.1.1"/>
            <p>ਆਦ ਵਿੱਚ ਪਰਮੇਸ਼ੁਰ ਨੇ ਅਕਾਸ਼ ਤੇ ਧਰਤੀ ਨੂੰ ਉਤਪਤ ਕੀਤਾ ।<verse eID="Gen.1.1"/>
                <verse osisID="Gen.1.2" sID="Gen.1.2"/>ਧਰਤੀ ਬੇਡੌਲ ਅਤੇ ਸੁੰਞੀ ਸੀ ਅਤੇ ਡੁੰਘਿਆਈ ਉੱਤੇ ਅਨ੍ਹੇਰਾ ਸੀ ਅਤੇ ਪਰਮੇਸ਼ੁਰ ਦਾ ਆਤਮਾ ਪਾਣੀਆਂ ਦੇ ਉੱਤੇ ਸੇਉਂਦਾ ਸੀ ।<verse eID="Gen.1.2"/>
                <verse osisID="Gen.1.3" sID="Gen.1.3"/>ਪਰਮੇਸ਼ੁਰ ਨੇ ਆਖਿਆ ਕਿ ਚਾਨਣ ਹੋਵੇ ਤਾਂ ਚਾਨਣ ਹੋ ਗਿਆ ।<verse eID="Gen.1.3"/>
                <verse osisID="Gen.1.4" sID="Gen.1.4"/>ਤਾਂ ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਡਿੱਠਾ ਭਈ ਚੰਗਾ ਹੈ ਅਤੇ ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਅਨ੍ਹੇਰੇ ਤੋਂ ਵੱਖਰਾ ਕੀਤਾ ।<verse eID="Gen.1.4"/>
                <verse osisID="Gen.1.5" sID="Gen.1.5"/>ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਦਿਨ ਆਖਿਆ ਤੇ ਅਨ੍ਹੇਰੇ ਨੂੰ ਰਾਤ ਆਖਿਆ ਸੋ ਸੰਝ ਤੇ ਸਵੇਰ ਪਹਿਲਾ ਦਿਨ ਹੋਇਆ ॥</p>
            <verse eID="Gen.1.5"/>

This would look much better:

            <chapter sID="Gen.1" osisID="Gen.1"/>
            <verse sID="Gen.1.1" osisID="Gen.1.1"/>
            <p>ਆਦ ਵਿੱਚ ਪਰਮੇਸ਼ੁਰ ਨੇ ਅਕਾਸ਼ ਤੇ ਧਰਤੀ ਨੂੰ ਉਤਪਤ ਕੀਤਾ ।
            <verse eID="Gen.1.1"/>

                <verse sID="Gen.1.2" osisID="Gen.1.2"/>ਧਰਤੀ ਬੇਡੌਲ ਅਤੇ ਸੁੰਞੀ ਸੀ ਅਤੇ ਡੁੰਘਿਆਈ ਉੱਤੇ ਅਨ੍ਹੇਰਾ ਸੀ ਅਤੇ ਪਰਮੇਸ਼ੁਰ ਦਾ ਆਤਮਾ ਪਾਣੀਆਂ ਦੇ ਉੱਤੇ ਸੇਉਂਦਾ ਸੀ ।
                <verse eID="Gen.1.2"/>

                <verse sID="Gen.1.3" osisID="Gen.1.3"/>ਪਰਮੇਸ਼ੁਰ ਨੇ ਆਖਿਆ ਕਿ ਚਾਨਣ ਹੋਵੇ ਤਾਂ ਚਾਨਣ ਹੋ ਗਿਆ ।
                <verse eID="Gen.1.3"/>

                <verse sID="Gen.1.4" osisID="Gen.1.4"/>ਤਾਂ ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਡਿੱਠਾ ਭਈ ਚੰਗਾ ਹੈ ਅਤੇ ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਅਨ੍ਹੇਰੇ ਤੋਂ ਵੱਖਰਾ ਕੀਤਾ ।
                <verse eID="Gen.1.4"/>

                <verse sID="Gen.1.5" osisID="Gen.1.5"/>ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਦਿਨ ਆਖਿਆ ਤੇ ਅਨ੍ਹੇਰੇ ਨੂੰ ਰਾਤ ਆਖਿਆ ਸੋ ਸੰਝ ਤੇ ਸਵੇਰ ਪਹਿਲਾ ਦਿਨ ਹੋਇਆ ॥</p>
            <verse eID="Gen.1.5"/>

The blank lines were also inserted to improve readability.

The example illustrated is for a Punjabi Bible.

The placement of paragraph elements in OSIS is also something I find inapprorpiate, but this can be addressed in a separate issue. I mention this here merely because this section of XML includes a

element in verse 1.

DavidHaslam commented 7 years ago

adyeths u2o script u2o.py already places sID before osisID.

Here is an example for the same work: (before pretty print)

<p>
<chapter sID="Gen.1" osisID="Gen.1" n="1" />
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1" />ਆਦ ਵਿੱਚ ਪਰਮੇਸ਼ੁਰ ਨੇ ਅਕਾਸ਼ ਤੇ ਧਰਤੀ ਨੂੰ ਉਤਪਤ ਕੀਤਾ ।
<verse eID="Gen.1.1" />
<verse sID="Gen.1.2" osisID="Gen.1.2" n="2" />ਧਰਤੀ ਬੇਡੌਲ ਅਤੇ ਸੁੰਞੀ ਸੀ ਅਤੇ ਡੁੰਘਿਆਈ ਉੱਤੇ ਅਨ੍ਹੇਰਾ ਸੀ ਅਤੇ ਪਰਮੇਸ਼ੁਰ ਦਾ ਆਤਮਾ ਪਾਣੀਆਂ ਦੇ ਉੱਤੇ ਸੇਉਂਦਾ ਸੀ ।
<verse eID="Gen.1.2" />
<verse sID="Gen.1.3" osisID="Gen.1.3" n="3" />ਪਰਮੇਸ਼ੁਰ ਨੇ ਆਖਿਆ ਕਿ ਚਾਨਣ ਹੋਵੇ ਤਾਂ ਚਾਨਣ ਹੋ ਗਿਆ ।
<verse eID="Gen.1.3" />
<verse sID="Gen.1.4" osisID="Gen.1.4" n="4" />ਤਾਂ ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਡਿੱਠਾ ਭਈ ਚੰਗਾ ਹੈ ਅਤੇ ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਅਨ੍ਹੇਰੇ ਤੋਂ ਵੱਖਰਾ ਕੀਤਾ ।
<verse eID="Gen.1.4" />
<verse sID="Gen.1.5" osisID="Gen.1.5" n="5" />ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਦਿਨ ਆਖਿਆ ਤੇ ਅਨ੍ਹੇਰੇ ਨੂੰ ਰਾਤ ਆਖਿਆ ਸੋ ਸੰਝ ਤੇ ਸਵੇਰ ਪਹਿਲਾ ਦਿਨ ਹੋਇਆ ॥
<verse eID="Gen.1.5" />
</p>

Here's the same section _after_ pretty print.
        <p>
            <chapter sID="Gen.1" osisID="Gen.1" n="1" />
            <verse sID="Gen.1.1" osisID="Gen.1.1" n="1" />ਆਦ ਵਿੱਚ ਪਰਮੇਸ਼ੁਰ ਨੇ ਅਕਾਸ਼ ਤੇ ਧਰਤੀ ਨੂੰ ਉਤਪਤ ਕੀਤਾ ।
            <verse eID="Gen.1.1" />
            <verse sID="Gen.1.2" osisID="Gen.1.2" n="2" />ਧਰਤੀ ਬੇਡੌਲ ਅਤੇ ਸੁੰਞੀ ਸੀ ਅਤੇ ਡੁੰਘਿਆਈ ਉੱਤੇ ਅਨ੍ਹੇਰਾ ਸੀ ਅਤੇ ਪਰਮੇਸ਼ੁਰ ਦਾ ਆਤਮਾ ਪਾਣੀਆਂ ਦੇ ਉੱਤੇ ਸੇਉਂਦਾ ਸੀ ।
            <verse eID="Gen.1.2" />
            <verse sID="Gen.1.3" osisID="Gen.1.3" n="3" />ਪਰਮੇਸ਼ੁਰ ਨੇ ਆਖਿਆ ਕਿ ਚਾਨਣ ਹੋਵੇ ਤਾਂ ਚਾਨਣ ਹੋ ਗਿਆ ।
            <verse eID="Gen.1.3" />
            <verse sID="Gen.1.4" osisID="Gen.1.4" n="4" />ਤਾਂ ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਡਿੱਠਾ ਭਈ ਚੰਗਾ ਹੈ ਅਤੇ ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਅਨ੍ਹੇਰੇ ਤੋਂ ਵੱਖਰਾ ਕੀਤਾ ।
            <verse eID="Gen.1.4" />
            <verse sID="Gen.1.5" osisID="Gen.1.5" n="5" />ਪਰਮੇਸ਼ੁਰ ਨੇ ਚਾਨਣ ਨੂੰ ਦਿਨ ਆਖਿਆ ਤੇ ਅਨ੍ਹੇਰੇ ਨੂੰ ਰਾਤ ਆਖਿਆ ਸੋ ਸੰਝ ਤੇ ਸਵੇਰ ਪਹਿਲਾ ਦਿਨ ਹੋਇਆ ॥
        </p>
DavidHaslam commented 7 years ago

Awaiting response since January. @refdoc @JohnAustinDev @HorstSchlemmer1731