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

Greg Hellings greg.hellings at gmail.com
Thu Jul 23 12:13:18 EDT 2020

On Thu, Jul 23, 2020 at 11:44 AM yvand <yvand.sword at gmail.com> wrote:

> Dear all,
> I am disappointed, because the issue still persists and nobody confirmed
> the bug. Although I already send to the mailing the source of the module
> FreCJE as asked and John Dudeck recently revived the issue with no
> success. Below is again my problem :
> I use OSIS commentary for "DayByDay" commentary. The module is called
> FreCJE (for French Chaque jour les Écritures) and is available in the
> main repository of Crosswire. Commentaries cover half or full part of a
> Bible chapter. For instance, here are the first commentaries :
> > <div type="section" annotateType="commentary"
> > annotateRef="Gen.1.1-Gen.1.19">...</div>
> > <div type="section" annotateType="commentary"
> > annotateRef="Gen.1.20-Gen.1.31">...</div>
> > <div type="section" annotateType="commentary"
> > annotateRef="Gen.2.1-Gen.2.14">...</div>
> > <div type="section" annotateType="commentary"
> > annotateRef="Gen.2.15-Gen.2.25">...</div>
> > <div type="section" annotateType="commentary"
> > annotateRef="Gen.3.1-Gen.3.13">...</div>
> > <div type="section" annotateType="commentary"
> > annotateRef="Gen.3.14-Gen.3.24">...</div>
> > etc.
> BUT when I use frontends, commentaries are ONLY shown when you are at
> the FIRST verse mentioned in the annotateRef. So Gen.1.1, Gen.1.20,
> Gen.2.1, Gen.2.15… will have a commentary, but not Gen.1.2, Gen.1.3…
> There seems to be no link entries for other verses as expected.
> I believe it worked fine years ago, but currently it seems broken :-(
> You can access and download the source of FreCJE using this link:
> https://yapper.fr/~yvand/frecje_v2.0.zip (OSIS file)
> Can you confirm the bug?

This is more of a UX design decision than a bug, specifically. But that
doesn't mean it can't be changed.

Or is it a .conf issue or something else? What
> can I do?

Offer a proposed patch to one or all of the front ends to change that UX

One consideration for it needs to be - what do you do if there are
overlapping annotations? What do you do if one entry is for Genesis 1:1-2:2
and then there are also passages for Genesis 1:1, Genesis 1:2, etc? Are
those both displayed at the same time? How do they look? How do you show
that they're different, and only one portion of them changes?

The problem is more of a design one than a technical one. Once all the
logic of the design is hammered out, someone will need to do the actual
code changes for it. It's not likely to be super tricky. Not too much of
the Sword or display code is opaque and inscrutable. But someone will still
need to put in the effort to make it happen.

So, the fastest way to get a solution, is to offer a fully formed proposal
of exactly how things should change and look and then offer changes to the
code that make it happen. If you don't have the skills for one or either of
those sides, then you'll have to wait for a volunteer to put in the work to
get them done.


> Thanks in advance for any help.
> Best regards,
> --yvand
> >
> > Yeah, you very much don't want to do that. The best plan is to send
> > the file to someone (Troy or DM or whoever owns osis2mod) or post it
> > publicly here so they can verify if it's the utility, the engine, or
> > front ends.
> >
> > Everything you've said, so far, sounds like it's just a front end
> > display problem and not a module or engine thing. But that can't be
> > guaranteed until someone looks closely at the output of the
> > appropriate tools to see what exactly is ending up in the module.
> >
> > --Greg
> _______________________________________________
> 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/20200723/4096420a/attachment.html>

More information about the sword-devel mailing list