[osis-core] Issues for Dallas
Patrick Durusau
osis-core@bibletechnologieswg.org
Sun, 18 May 2003 16:55:00 -0400
This is a multi-part message in MIME format.
--------------010700020502030303040006
Content-Type: text/plain; charset=us-ascii; format=flowed
Content-Transfer-Encoding: 7bit
Guys,
A very rough and no doubt incomplete cut on the issues and best
practices for Dallas.
Suggestion: Go ahead and edit the HTML and add issues, examples,
citations, etc., then email back to me. (Full examples, using entities
please, with solutions are welcome). I can cut-n-paste into the original
XML file from there.
Anticipate recording our decisions and best practices in the XML file so
we can produce daily updates in HTML for posting to the list. Seems like
a good way to track our work and get feedback while we are in Dallas.
The last time I can add issues will be Wednesday, say no later than 8:00
AM DST on the East Coast. I will post the final version by NOON. I will
have to leave for the airport about 12:30 PM.
Don't be discouraged by the length of the list. We are going to take a
few minutes the first day to organize them in terms of priority. Some
issues may have common solutions but we won't find them if we don't know
about the issues. Specific example citations help a lot!
BTW, Todd is by far and away the leader on issues at this point! Way to
go Todd!
Hope everyone is having a great day!
Patrick
--
Patrick Durusau
Director of Research and Development
Society of Biblical Literature
Patrick.Durusau@sbl-site.org
Co-Editor, ISO 13250, Topic Maps -- Reference Model
--------------010700020502030303040006
Content-Type: text/html; charset=us-ascii;
name="OSIS_Issues.html"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="OSIS_Issues.html"
<html>
<!--THIS FILE IS GENERATED FROM AN XML MASTER.
DO NOT EDIT-->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>OSIS Schema & Best Practices Issues</title>
<link rel="stylesheet" type="text/css" href="/stylesheets/tei-oucs.css">
<meta name="DC.Title" content="OSIS Schema & Best Practices Issues">
<meta name="DC.Author" content="">
<meta name="DC.Language" content="(SCHEME=iso639) en">
<meta name="DC.Creator" content="Oxford University Computing Services, 13 Banbury Road, Oxford OX2 6NN, United Kingdom">
<meta name="DC.Creator.Address" content="webmaster@oucs.ox.ac.uk">
</head>
<body><a name="TOP"></a><table class="header" width="100%">
<tr>
<td rowspan="3"></td>
<td align="left">
<h2 class="institution">Society of Biblical Literature</h2>
</td>
</tr>
<tr>
<td align="left">
<h1 class="maintitle">OSIS Schema & Best Practices Issues</h1>
</td>
</tr>
</table>
<hr>
<h2>Contents</h2>
<ul class="toc">
<li class="toc">1. <a class="toc" href="#body.1_div.1">Schema Bugs, Errors, Fixes</a><ul class="toc">
<li class="toc">1.1. <a class="toc" href="#OSIS_Issues-div-d0e37">Dead Elements - Removal Suggested</a><ul class="toc">
<li class="toc">1.1.1. <a class="toc" href="#OSIS_Issues-div-d0e42"><cell></a></li>
<li class="toc">1.1.2. <a class="toc" href="#OSIS_Issues-div-d0e51">milestones</a></li>
</ul>
</li>
</ul>
</li>
<li class="toc">2. <a class="toc" href="#body.1_div.2">Content Model Issues</a><ul class="toc">
<li class="toc">2.1. <a class="toc" href="#OSIS_Issues-div-d0e67"><div> attributes</a></li>
<li class="toc">2.2. <a class="toc" href="#OSIS_Issues-div-d0e76">Insert <divineName> in <catchWord></a></li>
<li class="toc">2.3. <a class="toc" href="#OSIS_Issues-div-d0e85"><table> in <p> and <speech></a></li>
<li class="toc">2.4. <a class="toc" href="#OSIS_Issues-div-d0e94">osisID as list, pointing at with osisRef with grain</a></li>
<li class="toc">2.5. <a class="toc" href="#OSIS_Issues-div-d0e106">osisRef as list?</a></li>
<li class="toc">2.6. <a class="toc" href="#OSIS_Issues-div-d0e115">xml:lang?</a></li>
</ul>
</li>
<li class="toc">3. <a class="toc" href="#body.1_div.3">Best Practices</a><ul class="toc">
<li class="toc">3.1. <a class="toc" href="#OSIS_Issues-div-d0e130">Major Issues</a><ul class="toc">
<li class="toc">3.1.1. <a class="toc" href="#OSIS_Issues-div-d0e135">Levels of Encoding</a></li>
<li class="toc">3.1.2. <a class="toc" href="#OSIS_Issues-div-d0e150">Milestones: Start and Stop</a></li>
<li class="toc">3.1.3. <a class="toc" href="#OSIS_Issues-div-d0e159">Predominant hierarchy</a></li>
<li class="toc">3.1.4. <a class="toc" href="#OSIS_Issues-div-d0e168">Quotes</a></li>
<li class="toc">3.1.5. <a class="toc" href="#OSIS_Issues-div-d0e177">Text in Verses</a></li>
<li class="toc">3.1.6. <a class="toc" href="#OSIS_Issues-div-d0e186">Verse splits</a></li>
</ul>
</li>
<li class="toc">3.2. <a class="toc" href="#OSIS_Issues-div-d0e196">Lesser Issues</a><ul class="toc">
<li class="toc">3.2.1. <a class="toc" href="#OSIS_Issues-div-d0e201">blockQuote vs. Speech</a></li>
<li class="toc">3.2.2. <a class="toc" href="#OSIS_Issues-div-d0e210">Book Titles</a></li>
<li class="toc">3.2.3. <a class="toc" href="#OSIS_Issues-div-d0e219">catchWord</a></li>
<li class="toc">3.2.4. <a class="toc" href="#OSIS_Issues-div-d0e228">Complex or discontinuous text</a></li>
<li class="toc">3.2.5. <a class="toc" href="#OSIS_Issues-div-d0e237">Continuing Paragraph</a></li>
<li class="toc">3.2.6. <a class="toc" href="#OSIS_Issues-div-d0e246">Copyright pages</a></li>
<li class="toc">3.2.7. <a class="toc" href="#OSIS_Issues-div-d0e255">Cross-References in <title></a></li>
<li class="toc">3.2.8. <a class="toc" href="#OSIS_Issues-div-d0e270">Dictionary</a></li>
<li class="toc">3.2.9. <a class="toc" href="#OSIS_Issues-div-d0e279"><div> following <osisText></a></li>
<li class="toc">3.2.10. <a class="toc" href="#OSIS_Issues-div-d0e288">endings, multiple</a></li>
<li class="toc">3.2.11. <a class="toc" href="#OSIS_Issues-div-d0e297">Footnotes</a></li>
<li class="toc">3.2.12. <a class="toc" href="#OSIS_Issues-div-d0e306">Identifier with element</a></li>
<li class="toc">3.2.13. <a class="toc" href="#OSIS_Issues-div-d0e321">Introduction content</a></li>
<li class="toc">3.2.14. <a class="toc" href="#OSIS_Issues-div-d0e330">Lines within a line group</a></li>
<li class="toc">3.2.15. <a class="toc" href="#OSIS_Issues-div-d0e339">Major and minor divisions</a></li>
<li class="toc">3.2.16. <a class="toc" href="#OSIS_Issues-div-d0e348">Milestone Pairs</a></li>
<li class="toc">3.2.17. <a class="toc" href="#OSIS_Issues-div-d0e357">Misc. but common structures</a></li>
<li class="toc">3.2.18. <a class="toc" href="#OSIS_Issues-div-d0e366">Notes</a></li>
<li class="toc">3.2.19. <a class="toc" href="#OSIS_Issues-div-d0e375">Parallel passages</a></li>
<li class="toc">3.2.20. <a class="toc" href="#OSIS_Issues-div-d0e384">Presentation Punctuation in References</a></li>
<li class="toc">3.2.21. <a class="toc" href="#OSIS_Issues-div-d0e393">Reference encoding</a></li>
<li class="toc">3.2.22. <a class="toc" href="#OSIS_Issues-div-d0e411">Reference to entire work</a></li>
<li class="toc">3.2.23. <a class="toc" href="#OSIS_Issues-div-d0e420">Special Information</a></li>
<li class="toc">3.2.24. <a class="toc" href="#OSIS_Issues-div-d0e429">Split</a></li>
<li class="toc">3.2.25. <a class="toc" href="#OSIS_Issues-div-d0e438">Stanza</a></li>
<li class="toc">3.2.26. <a class="toc" href="#OSIS_Issues-div-d0e447">Title Page</a></li>
<li class="toc">3.2.27. <a class="toc" href="#OSIS_Issues-div-d0e456">Translator practices</a></li>
<li class="toc">3.2.28. <a class="toc" href="#OSIS_Issues-div-d0e465">Verse value</a></li>
<li class="toc">3.2.29. <a class="toc" href="#OSIS_Issues-div-d0e474">Work related practices</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="teidiv">
<h2><a name="body.1_div.1"></a>1. Schema Bugs, Errors, Fixes
</h2>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e37"></a>1.1. Dead Elements - Removal Suggested
</h3>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e42"></a>1.1.1. <cell>
</h4>
<p><a name="d0e47"></a>Has attributes of rows and columns (delete).
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e51"></a>1.1.2. milestones
</h4>
<p><a name="d0e56"></a>osisMilestoneSe, milestoneSe, osisMilestonePt, and milestonePt should be deleted.
</p>
</div>
</div>
</div>
<div class="teidiv">
<h2><a name="body.1_div.2"></a>2. Content Model Issues
</h2>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e67"></a>2.1. <div> attributes
</h3>
<p><a name="d0e72"></a>Add section, front, body, back, titlePage, introduction, index, preface, afterword, colophon, lexeme to type attribute on
<div>.
</p>
</div>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e76"></a>2.2. Insert <divineName> in <catchWord>
</h3>
<p><a name="d0e81"></a>The <divineName> element is meant to control imposition of styling. If not included in <catchWord>, must use ad hoc methods,
leading to inconsistent encoding and more complex stylesheets.
</p>
</div>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e85"></a>2.3. <table> in <p> and <speech>
</h3>
<p><a name="d0e90"></a>Should table be allowed in <p> and <speech>?
</p>
</div>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e94"></a>2.4. osisID as list, pointing at with osisRef with grain
</h3>
<p><a name="d0e99"></a>Ex. osisID="Matt.1.2 Matt.1.3 Matt.1.4" would osisRef="Matt.1.2@ch14" be the SAME as osisRef="Matt.1.3@ch14"
</p>
<p><a name="d0e102"></a>Problem is that the grain reference has to have a certain staring point and that can only be the first osisID. Other issue
is blind pointing, how do I know if the author has used osisID as a list?
</p>
</div>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e106"></a>2.5. osisRef as list?
</h3>
<p><a name="d0e111"></a>Should osisRef be allowed to be a list, like osisID? Would allow <note> to be applied to discontinuous material, avoiding
Todd's annotation extension.
</p>
</div>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e115"></a>2.6. xml:lang?
</h3>
<p><a name="d0e120"></a>Should we replace lang with xml:lang?
</p>
</div>
</div>
<div class="teidiv">
<h2><a name="body.1_div.3"></a>3. Best Practices
</h2>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e130"></a>3.1. Major Issues
</h3>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e135"></a>3.1.1. Levels of Encoding
</h4>
<p><a name="d0e140"></a>Category A: Bibles with just the scripture text and no notion of paragraphs and organized with a book/chapter/verse hierarchy.
</p>
<p><a name="d0e143"></a>Category B: Bibles with paragraphs but no sections, with the paragraphs held by chapter <div> elements.
</p>
<p><a name="d0e146"></a>Category C: Bibles with sections and paragraphs, where sections as <div type="x-section"> elements contain paragraphs.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e150"></a>3.1.2. Milestones: Start and Stop
</h4>
<p><a name="d0e155"></a>The use of milestone start and end elements
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e159"></a>3.1.3. Predominant hierarchy
</h4>
<p><a name="d0e164"></a>What is the best hierarchy to use for biblical texts?
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e168"></a>3.1.4. Quotes
</h4>
<p><a name="d0e173"></a>Strategy for quotes (not likely to be the predominant hierarchy)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e177"></a>3.1.5. Text in Verses
</h4>
<p><a name="d0e182"></a>Strategy to put ALL scripture text within a <verse> element.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e186"></a>3.1.6. Verse splits
</h4>
<p><a name="d0e191"></a><verse> element split in <lg>, <list>, and <table> and should the
schema be changed
</p>
</div>
</div>
<div class="teidiv">
<h3><a name="OSIS_Issues-div-d0e196"></a>3.2. Lesser Issues
</h3>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e201"></a>3.2.1. blockQuote vs. Speech
</h4>
<p><a name="d0e206"></a>Guidelines on usage?
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e210"></a>3.2.2. Book Titles
</h4>
<p><a name="d0e215"></a>For <title> elements, use the type attributes "short" for the short title like "Matthew", "mainTitle" for the main title,
and "subTitle" for any sub titles for the book. (The same could be applied to testaments and book groups.)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e219"></a>3.2.3. catchWord
</h4>
<p><a name="d0e224"></a>Catchword (unbalanced quotes, <divineName>, etc..)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e228"></a>3.2.4. Complex or discontinuous text
</h4>
<p><a name="d0e233"></a>Marking AddEsther where chapters interrupt other chapters and alternant reference systems are present.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e237"></a>3.2.5. Continuing Paragraph
</h4>
<p><a name="d0e242"></a>How to best encode a continuing paragraph after a block quote of line group.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e246"></a>3.2.6. Copyright pages
</h4>
<p><a name="d0e251"></a>How to deal with the copyright page and the related <work> element
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e255"></a>3.2.7. Cross-References in <title>
</h4>
<p><a name="d0e260"></a>Should cross-references following a <title> be placed in a child <title> element?
</p>
<p><a name="d0e263"></a>Example:
<pre>
<div type="x-section" osisRef="Matt.3.1-Matt.3.12">
<title type="section">The Preaching of John the Baptist
<title type="cross-ref"><reference
osisRef="Mark.1.1-Mark.1.8" type="parallelPassage">Mark
1.1-8</reference> <reference osisRef="Luke.3.1-Luke.3.18"
type="parallelPassage">Luke 3.1-18</reference> <reference
osisRef="John.1.19-John.1.28" type="parallelPassage">John
1.19-28</reference></title></title>
</pre>
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e270"></a>3.2.8. Dictionary
</h4>
<p><a name="d0e275"></a>How to encode a dictionary and other content at the end of a Bible
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e279"></a>3.2.9. <div> following <osisText>
</h4>
<p><a name="d0e284"></a>How to best organize top level structure for introduction sections, mini-dictionaries, glossaries, maps
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e288"></a>3.2.10. endings, multiple
</h4>
<p><a name="d0e293"></a>Multiple endings (marking container elements and osisIDs)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e297"></a>3.2.11. Footnotes
</h4>
<p><a name="d0e302"></a>Footnotes (<rdg> and superscripted numbers)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e306"></a>3.2.12. Identifier with element
</h4>
<p><a name="d0e311"></a>The question I have is how do associate an identifier with an element. For example if I wanted to say that a paragraph or
other block of text is about "anger".
</p>
<p><a name="d0e314"></a>The best I can come up with is a <note> element with an osisRef to desired text. (Similar to a cross reference)
</p>
<p><a name="d0e317"></a>This will work with scripture text with a well defined reference system, but for non-Biblical text that often does not have
osisIDs this becomes an issue. (This would likely be resolved if XPath/XPointer like syntax were allowed in a reference or
reference like element.) (Todd)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e321"></a>3.2.13. Introduction content
</h4>
<p><a name="d0e326"></a>The text found at the front of a bible, testament, book group, or book. Contain this type of content in a <div type="x-introduction">
element.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e330"></a>3.2.14. Lines within a line group
</h4>
<p><a name="d0e335"></a>Use type="q", type="q2" (or similar type names) and a set of other standardized types to indicate the specific nature of the
<l> element.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e339"></a>3.2.15. Major and minor divisions
</h4>
<p><a name="d0e344"></a>Major and minor divisions in the text.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e348"></a>3.2.16. Milestone Pairs
</h4>
<p><a name="d0e353"></a>Some guidelines on how to use milestone pairs for chapters, verses, and quotes and how to be consistent in the use of milestones
vs elements.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e357"></a>3.2.17. Misc. but common structures
</h4>
<p><a name="d0e362"></a>glossary, map, mini-dictionary, Thompson Chain Reference (Todd), see http://www.zondervan.com/media/pdfs/0310912229.pdf for
example (I have a local copy for the meeting. pld)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e366"></a>3.2.18. Notes
</h4>
<p><a name="d0e371"></a>A "best practices" guideline for type attributes that indicate the type of note.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e375"></a>3.2.19. Parallel passages
</h4>
<p><a name="d0e380"></a>Use a <div type="parallelPassage"> with strictly a set of <reference> elements and the related display text as children.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e384"></a>3.2.20. Presentation Punctuation in References
</h4>
<p><a name="d0e389"></a>The best way to encode a series of references with various presentation punctuation.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e393"></a>3.2.21. Reference encoding
</h4>
<p><a name="d0e398"></a>In OSIS documents that are not Bibles, it is a common to see a quote of
scripture text followed by the reference.
</p>
<p><a name="d0e401"></a>Does it make sense to add an optional osisRef attribute to <q> and
<milestoneStart> to accommodate this frequent issue?
</p>
<p><a name="d0e404"></a>Example:
<q osisRef="Matt.20.28">The Son of Man did not come to be served, but
to serve . . . </q>
</p>
<p><a name="d0e407"></a>rather than
<q>The Son of Man did not come to be served, but to serve . .
.<reference osisRef="Matt.20.28">Matthew 20:28</reference></q> (Todd)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e411"></a>3.2.22. Reference to entire work
</h4>
<p><a name="d0e416"></a>Introduction to CEV has references to entire works. How to encode? (Todd)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e420"></a>3.2.23. Special Information
</h4>
<p><a name="d0e425"></a>How to preserve special information related to verse numbers that can not be represented with an osisID ("*1") at Bible.CEV.Gen.49.1.
(Is this really a note?)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e429"></a>3.2.24. Split
</h4>
<p><a name="d0e434"></a>Only split AND only use the attribute "splitID" for the following elements: <verse>, <div type="chapter">, <div type="x-section">,
and <p>.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e438"></a>3.2.25. Stanza
</h4>
<p><a name="d0e443"></a>How to best encode "stanza" in the Psalms.
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e447"></a>3.2.26. Title Page
</h4>
<p><a name="d0e452"></a>How to deal with the title page
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e456"></a>3.2.27. Translator practices
</h4>
<p><a name="d0e461"></a>How to encode the idea created by the translator that leads to a blank line being rendered? (This would be additional spacing
than would normally exist between two paragraphs to emphasize a shift in thought.)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e465"></a>3.2.28. Verse value
</h4>
<p><a name="d0e470"></a>Use the n attribute to indicate the verse value to present when more than one value is present in an osisID. (Eg. <verse
n="1-2" osisID="Matt.1.1 Matt.1.2">)
</p>
</div>
<div class="teidiv">
<h4><a name="OSIS_Issues-div-d0e474"></a>3.2.29. Work related practices
</h4>
<p><a name="d0e479"></a>Work related practices for different scenarios. (I am thinking primarily about the "thisWork" element.)
</p>
</div>
</div>
</div>
<hr>
<div class="footer"><a class="plain" target="_top" href="http://www.ox.ac.uk/">Society of Biblical Literature</a>
| <a class="plain" target="_top" href="http://www.sbl-site.org">SBL</a></div>
<hr>
<address>Date:
Author: .
<br><a href="/documentation/copyright.html">©</a> Society of Biblical Literature.
<!--
Generated from OSIS_Issues using an XSLT version 1 stylesheet
based on http://www.oucs.ox.ac.uk/stylesheets/teihtml.xsl
processed using SAXON 6.5 from Michael Kay on 2003-05-18T16:43:55Z-->
</address>
</body>
</html>
--------------010700020502030303040006--