[osis-users] OSIS cross-reference questions

Troy A. Griffitts scribe at crosswire.org
Thu Apr 26 07:48:40 MST 2012

In addition to David's great response, we have a tool for generating 
OSIS reference tags from adhoc verse text.  The output might be interesting:



In addition, for the "this note is annotating a large section" question. 
  There is a global annotateRef which you should probably use on the 
note tag.  Ultimately, you'll want the note tag to live at the point in 
your document where you'll want your end users to see it in display 
software, if the display software simply shows note markers inline, but 
the annotateRef attribute will give more sophisticated software the data 
it needs to do better.


On 04/26/2012 02:18 PM, David Troidl wrote:
> Hi,
> On 4/26/2012 7:45 AM, Markku Pihlaja wrote:
>> It's been a while since my last message - our project (the Finnish
>> OSIS Bible) has been on hold for a while for various reasons - but now
>> I'm finally back on the job.
>> I sent these three questions to the list a few months ago but never
>> got any answer - possibly because my list membership hadn't been
>> confirmed yet. I'd guess someone has some answers to these, so I'll
>> resend them here.
>>     Here are three cross-reference related questions.
>>     1)
>>     How should I encode cross-references to non-contiguous verse
>>     ranges? For example, I have this reference (in our standard
>>     notation): Matt. 27:17,22. This is formally just one reference to
>>     verses 17 and 22, not two separate references. OSIS requires that
>>     "a single osisRef cannot identify a discontiguous range of a
>>     work". So how should this be done? Making one note that contains
>>     two references might be a step towards what I want, but there
>>     would still be two separate references.
>>     I would like to have something that enables for example an
>>     implementation where hovering the mouse over a (cross-reference)
>>     link would open a popup with just the referenced text highlighted,
>>     even though it wasn't contiguous. Two separate references would
>>     lead to two different popups on different hovering points, which
>>     wouldn't be right.
> Here is the way to encode discontiguous references:
> <note type="crossReference"><reference osisRef="Matt.27.17">Matt.
> 27:17</reference>, <reference osisRef="Matt.27.22">22</reference></note>
> The markup doesn't determine the display. If you can identify these
> cases, you can display them any way you want.
>>     2)
>>     How should I encode a cross-reference with the *referring*
>>     position consisting of more verses than just one? For example,
>>     Matthew 1:1-17 has a cross-reference to Luke 3:23-38. Just placing
>>     a note containing a reference in Matthew 1:1 wouldn't tell that
>>     it's the whole passage of 17 verses that refers to Luke. Would
>>     that reference need to have an osisID listing all 17 verses
>>     separately? That also wouldn't really be correct, since the
>>     referer is not the 17 individual verses but the entire passage.
> osisRef is a universal attribute. You could use that, if necessary, on
> the note element.
> <note type="crossReference" osisRef="Matt.1.1-Matt.1.17"><reference
> osisRef="Luke.3.23-Luke.3.38">Luke 3:23-38</reference></note>
>>     3)
>>     Our cross-references are currently listed on a verse-by-verse
>>     basis in a separate file. Each verse might have a number of
>>     references, most of them separated by a semi-colon. However, in
>>     some cases the separator is the vertical line character, | (or the
>>     pipe sign). This indicates a fine grained division of the source
>>     verse. That's *source*, not target. For example,
>>     Luuk. 2:4-7 ¦ Dan. 1:20
>>     would say that the beginning of the referring verse refers to Luke
>>     2:4-7, and the end to Daniel 1:20. There can be up to 4 divisions
>>     like this in one verse. However, there is no automatic way of
>>     determining what the exact division of the source verse is. In
>>     fact, in some cases even I can't read the verse and tell the
>>     division without reading the referenced verses first.
>>     This means that in any case I'll probably need to leave the OSIS
>>     coding vague in this respect. My question here: is there a way to
>>     somehow indicate the existence of this division within the tags,
>>     or is the only way to continue marking it like it was done until
>>     now, like this:
>>     <reference section1a.... />; <reference section1b.... /> |
>>     <reference section2.... /> | <reference section3a.... />;
>>     <reference section3b.... />
>>     Could that be done by using osisID's like
>>     Matt.1.1!crossReference.section1.a
>>     Matt.1.1!crossReference.section1.b etc.
>>     or is there a better way?
> I'm not exactly clear what you are asking here. If you want to mark up
> the notes, without changing the markup of the Bible text, you could use
> word numbers within the verse, to indicate where the note applies.
> Peace,
> David
>>     Markku
>> _______________________________________________
>> osis-users mailing list
>> osis-users at crosswire.org
>> http://www.crosswire.org/mailman/listinfo/osis-users
> _______________________________________________
> osis-users mailing list
> osis-users at crosswire.org
> http://www.crosswire.org/mailman/listinfo/osis-users

More information about the osis-users mailing list