[sword-devel] Not user-friendly behavior in commentaries (should be continuous)

[Greg Hellings]

On Mon, Jun 1, 2020 at 8:29 AM yvand <yvand.sword at gmail.com> wrote:

>
>
> On Sat, May 30, 2020 at 11:19 AM Karl Kleinpaste <karl at kleinpaste.org>
> wrote:
>
>> On 5/30/20 11:45 AM, yvand wrote:
>>
>> I think Karl already talked about this feature in the past. But maybe I
>> am wrong, I did not find the conversation.
>>
>>
>> Xiphos has a feature, "commentary by chapter," so that whole commentary
>> chapters are displayed along with whole Bible chapters, and then the verse
>> is tracked visually in the commentary pane, but in a different manner from
>> the Bible pane (i.e. current verse always aligned to top, plus a preceding
>> horizontal rule).  It's a UI issue IMO, not an engine issue.  If you
>> explicitly list the verse range covered in your markup, then I imagine you
>> might get the effect you want in other UIs.
>>
>> Up to this time, Xiphos' commentary by chapter has not been default, and
>> I wonder if I should make it so in the future.
>>
>
> I think so. Since Bibles are by chapter, it makes sense to have
> commentaries as well, but :
>
> A commentary view in frontends, as Karl mentioned, might be a good thing.
>
> I still don't understand why the OSIS reference "Gen.1.1-Gen.1.19" is
> interpreted as "Gen.1.1" only! Again, why this behavior? It seems not
> logical for me. Are commentaries in OSIS only verse by verse?
>
I think your problem comes from a two-fold issue:

1) Commentaries are typically done verse-by-verse in front end displays.
This is a UX decision and can be argued both for and against.
2) OSIS documents - particularly Bibles - can have a single entry that
represents multiple verses. This is common in both commentaries and
paraphrase translations. But most front ends likely use the same code to
handle both, because Sword handles them exactly the same. There, because
Bibles would look weird if the same text was repeated in 2 or more
consecutive verses, any range values are skipped for subsequent values not
at their start.

So what you are seeing is a bug in the front ends. If they are going to
display verse-by-verse commentary then they would need to NOT employ the
skip-linked-text code that their Bible display uses.

Your module is likely encoded correctly. The Sword engine seems to be
operating correctly. You will need to file a bug with the various front
ends that are not displaying the module well to either change their UX like
Karl says he did for Xiphos or to fix the linked verse display bug that
they seem to be suffering from.

--Greg

> And issues are still there:
>
> - A commentary like "Gen.7.17-Gen.8.5" (in FreCJE = Day by Day, by J.
> Koechlin in French) will only be shown at chapter 7, isn't it? I should
> also use a "hack" and put an OSIS reference like ""Gen.7.17 Gen.8.1" (not
> use continuous reference notation).
>
> - It would be impossible to highlight properly the commentary as you
> mentioned (if I understood correctly).
>
> This is again my 2 cents.
> _______________________________________________
> sword-devel mailing list: sword-devel at crosswire.org
> http://www.crosswire.org/mailman/listinfo/sword-devel
> Instructions to unsubscribe/change your settings at above page
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.crosswire.org/pipermail/sword-devel/attachments/20200601/c9706933/attachment.html>