[osis-core] use cases

[Todd Tillinghast]

> OK, I'm kindof lost on many of the terms and tags being thrown around.
> Could we give excerpts from an XML doc for a few use cases.  I've
> included my best guess or suggestion for each.  Please follow the
> reference in #12 if you find yourself in ill attitude :)  Thanks for
> humoring me.  I really need this, as I am quickly losing coherency on
> these matters :)
> 
> 
> 
> 
> 1)  I am this work
> 
> (from Todd's submission)
> <osisText osisWork="eckhart_sermons">
> 
> 
> 2)  All my osisID, self identifying anchors use this reference system
> unless individually, explicitely stated otherwise.
> 
> ????????? something like the following was suggested by Todd ?????????
> <osisText refSystem="Bible.KJV">
> 
> 
> 3)  All my osisRef's use KJV reference system unless individually,
> explicitely stated otherwise
> 
> ?????????
> <osisText osisWork="work1" refSystem="augustine_confessions.pusey"
> defaultRefSystem="Bible.KJV">

My intention with "refSystem" was to declare the default reference
system.  So in this example you would have choose for either "Bible.KJV"
or "augustine_confessions.pusey" to be the default reference system.
 
> 
> 
> *** Following items assume a documents 1 and 2 items above, somehow
> define work: KJV, refSystem: KJV
> 
> 4)  I am a verse that is Jas 1:19
> 
> <verse osisID="Jas.1.19">

Yes

> 
> 
> 5)  I am a div that contains Jas 1:19 AND Jas 1:20
> 
> <div osisID="Jas.1.19 Jas.1.20">
> 

Although this is allowed syntactically I don't think this is a great
idea.  In the earlier post regarding osisRef this was one of the three
cases where I think an osisRef makes sense other than in <reference>.  I
would like to see something like 
<div containsRef="Jas.1.19-Jas.1.20"> for this purpose where containsRef
has the same form as osisRef but a different name to reduce confusion
regarding its purpose.

> 
> 6)  I am a div that contains all of Jas
> 
> <div osisID="Jas">

Yes.

> 
> 
> *** Following items assume a documents 1, 2, and 3 items above,
somehow
> define (respectively) work: MHC (Matthew Henry's Commentary),
refSystem:
> KJV, defaultRefSystem: KJV
> 
> 
> 7)  I am a div that is commentary on Jas.1.19-21
> 
> ?????
> <div osisID="Jas.1.19 Jas.1.20 Jas.1.21">

I don't think this makes sense because the <div> is not those verses but
rather a commentary on those verses.  I think that the following would
be the preferred encoding.

<osisText work="mhc" refSystem="Bible.KJV>
	<div>
		<div>
			<reference osisRef="Jas.1.20"
type="commentary"/>
		</div>
	</div>
</osisText>
> 
> (I still like this suggested markup, as it allow us to say: See
comments
> from Matthew Henry on <reference work="mhc" osisRef="Jas.1.20">James
> 1:20</reference>)

The fact that a "work" attribute remains in reference is simply because
it has not been deleted and is a throw back to when the work (really the
reference system) and reference were separate.  Now that the reference
system is a part of the reference itself the "work" attribute is
obsolete and just needs to be removed.

> 
> 
> 8)  I am a reference to any Bible that contains Jas.1.19 using my
> default KJV reference system.
> 
> <reference osisRef="Jas.1.19">This</reference> might be a hyperlink to
> any Bible containing James 1:19.
> 

Yes.  You could use this to create the hyperlink that Harry is wanting
to see, but it is not a hyperlink until some software does something to
it.

> 
> 9)  I am a reference to any Bible that contains Jas.1.19, but I want
to
> use something besides my default *REFERENCE SYSTEM* for some odd
reason :)
> 
> <reference osisRef="Bible.NIV:Jas.1.19">
> 

Yes, a reference to any Bible that contains Jas.1.19 as defined in the
Bible.NIV reference system.

> 

> 10)  I want to refer to the NIV *WORK* using my default KJV reference
> system.
> 
> <reference work="niv" osisRef="Jas.1.19">
> 

Work is obsolete and is only present by error.

<reference osisRef="Bible.KJV(Bible.NIV):Jas.1.19"/>
specifies the specific the verse Jas.1.19 as defined in the Bible.KJV
reference system and specifically says the Bible.NIV work.

There is not way to specify the work with out specifying the reference
system.

> 
> 11)  I want to refer to the NIV *WORK* using the NIV *REFERENCE
SYSTEM*
> (which is not my default which is KJV)
> 
> <reference work="niv" osisRef="Bible.NIV:Jas.1.19">

Again, work is obsolete and is only present by error.

<reference osisRef="Bible.NIV(Bible.NIV):Jas.1.19"/>
specifies the specific the verse Jas.1.19 as defined in the Bible.NIV
reference system and specifically says the Bible.NIV work.

> 
> 
> 12) (because there should be 12)  I want to refer to a work: naves
> (Naves Topical Textbook), using naves reference system (obviously) to
a
> div in naves that was tagged with an osisID="GRACE"
> 
> Please see Nave's Topical Textbook entry on <reference work="naves"
> osisRef="naves:GRACE">Grace</reference>
> 
I like this one.  I think that 
<reference osisRef="naves:GRACE"/> would be correct.  

If the work is necessary then
<reference osisRef="naves(naves):GRACE"/> would be correct assuming that
a <work> and <refSystem> element are both defined in the header using
the name="naves".

Todd