[osis-core] dump of current doc state....
Steven J. DeRose
osis-core@bibletechnologieswg.org
Thu, 3 Jul 2003 13:41:44 -0400
--============_-1154868386==_============
Content-Type: text/plain; charset="us-ascii" ; format="flowed"
Still to do:
describe a bunch of little elements
describe a lot of type attribute values
add tons of examples
add small-scale markup like for element and attribute names
add index entries
--
Steve DeRose -- http://www.derose.net
Chair, Bible Technologies Group -- http://www.bibletechnologies.net
Email: sderose@acm.org or steve@derose.net
--============_-1154868386==_============
Content-Id: <a05200f0cbb2a1a9c1456@[192.168.1.101].0.0>
Content-Type: text/plain; name="osisUserManual.xml"; charset="us-ascii" ; format="flowed"
Content-Disposition: attachment; filename="osisUserManual.xml"
; modification-date="Thu, 3 Jul 2003 13:35:17 -0400"
<?xml version="1.0"?>
<?xml-stylesheet type="text/css" href="teixlite.css"?>
<!DOCTYPE TEI.2 PUBLIC "-//TEI//DTD TEI Lite XML ver. 1//EN"
"c:/tei-emacs/xml/dtds/tei/teixlite.dtd" [
<!ENTITY trade "(tm)">
]>
<TEI.2>
<teiHeader>
<fileDesc>
<titleStmt>
<title>OSIS 1.5 User's Manual</title>
</titleStmt>
<publicationStmt>
<p>A publication of the Bible Technologies Group, a joint effort
of the American Bible Society, the Society of Biblical Literature,
and other organizations in furtherance of OSIS, an Open Scriptural
Information Standard.</p>
</publicationStmt>
<sourceDesc>
<p>An original composition so no source document.</p>
</sourceDesc>
<revDesc><date>2003:07:01</date>
<p>sjd: Annotated alpha list of elements. Reworked reference and
work sections and added type, scope, and explanations of type and
subtype for work. Explained a bunch more elements and attributes.</p>
</revDesc>
<revDesc><date>2003:06:17</date>
<p>sjd: Wrote conformance section. Added lists of elements and
attributes, USMARC list. Inserted placeholders for doc on all element
types. Got document back to XML WF. Wrote CSS stylesheet.</p>
</revDesc>
<revDesc><date>2003:06:14</date>
<p>sjd: Pulled in many other doc scraps, description of refsystem,
listed and organized all elements, wrote doc for header and basic
markup. Updated some things to match version 1.5. Added section on
time formats. </p>
</revDesc>
<revDesc><date>2003:06</date>
<p>prd: Initial version (partly based on tutorial by Troy Griffiths?)</p>
</revDesc>
</fileDesc>
</teiHeader>
<text>
<body>
<div>
<head>Introduction</head>
<p>
Welcome to the OSIS (Open Scriptural Information Standard) User's
Manual. OSIS is a set of XML structures that can be used to produce
Bibles, commentaries, and related texts that can be easily
interchanged with other users, formatted as HTML, PDF, Postscript or
any other desired format, and searched on any personal computer. It
provides a standard way to express such documents, which is important
because it saves time, money, and effort for:
</p>
<list>
<item><p>
authors, who will have less need to adjust their manuscripts for each
different potential publisher;
</p></item>
<item><p>
publishers, who will gradually come to experience lower costs by not
having to manage converting texts presented by authors in so wide a
variety of formats, and by not having to provide texts in a different
form to each electronic-book system vendor out there (or pay
indirectly for those vendors to do the conversions).
</p></item>
<item><p>
and software vendors, who can avoid writing a lot of code to manage
different formats, and thus make their programs smaller, faster, and
more reliable.
</p></item>
</list>
<p>
In addition, the OSIS development team closely studied previous Bible
encoding forms, as well as tools for literary encoding in general. By
doing this we hope we have avoided some weaknesses, and gained from
some strengths, of each one, and we thank the many people who worked
on those prior specifications, as well as those who have provided
help and feedback in developing OSIS itself, and testing it by
encoding large numbers of Biblical and related texts. A list of
participants may be found in an Appendix.</p>
<p>Users familiar with the Text Encoding Initiative will find OSIS
markup quite familiar, because the bulk of the elements we define
correspond directly to TEI elements, and almost always have the same
name (though often simplified content). The schema also provides a
TEIform attribute for such elements, so they can be recognized by
form-aware processors as equivalent to their TEI counterparts. We
have attempted to point out any elements below that do not have TEI
equivalents, for the sake of anyone using both systems.
</p>
<p>OSIS is provided as a free resource by the Bible Technologies
Group (or BTG), which is a collaborative effort of the American Bible
Society, the Society of Biblical Literature, the Summer Institute of
Linguistics, the United Bible Society, and individual volunteers
around the world. OSIS is designed to meet the needs of diverse user
communities who read, study, research, translate or distribute
biblical texts. This introduction gives a brief overview of OSIS
before leading you step by step through producing your first OSIS
text.</p>
</div>
<div><head>Getting started</head>
<p>The first question that is often asked when learning that OSIS
uses XML (a markup language) is: "I'm not a computer person. Can
I learn to use OSIS?" If you can type and use even the most
basic word processor or computer text-editing program, the answer is
clearly "Yes!" OSIS was designed to be offer the beginning
user a simple way to do the basic "markup" required for a standard
biblical text. "Markup" refers to markers placed within the text,
that indicate where useful units (or "elements") such as verses,
quotations, cross-references, and other things begin and end.</p>
<p>If you know HTML, you already know most of what you need to know
to use OSIS; OSIS uses the same pointy-bracket syntax as HTML (or
XHTML to be completely precise). It merely provides a different set
of element and attribute names. A few names such as "p" and "div" are
the same; others are new, such as "verse". The core set of elements
for OSIS is actually smaller than the set for HTML 3.2. To be sure
there are some complex cases that we deal with later, but you can do
useful work with no more information than is provided in this basic
manual.</p>
<p>The second question that is most often asked is: <q>Do I need an
XML editor to do OSIS?</q> This question often comes up after a
friend of a friend has recommended some editor, and you then checked
its price. XML editors vary from free to over $10,000.00 (US), and
many are difficult to use (though XMetal™ is a notable
exception, and not very expensive). </p>
<p>
The basic answer is no, you do not need any special software. You can
use any text editor you like to create OSIS documents (or any other
XML documents, for that matter). Many will even color the tags for
you, because they know how to color HTML tags and the languages are
similar enough. However, you should have a way to check your
documents for errors -- if your editor doesn't know enough about XML
to warn you if you misspell a tag, or forget to end some element that
you started, you will want to check for errors periodically using an
"XML validator". Many such program are available for various
computers; some are available as Web services. Both Internet Explorer
and Netscape can also validate an OSIS file once you have installed
the OSIS rules file (called a "schema") and an appropriate stylesheet.
</p>
<p>
An OSIS-aware text editor will do this checking for you, either on
demand or continuously. A friendlier OSIS-aware text editor will
provide help by showing you just which elements are permitted at any
given place (for example, you can't insert a Bible book within a
footnote). The friendliest editors also give you the option to see
and edit a fully-formatted view on demand, rather than staring
directly at pointy-brackets. The choice between the many tools is a
personal one, dictated by your working style, level of technical
sophistication, goals, budget, and other factors.
</p>
<p>
The OSIS team is working even as this manual is being written to
adapt free authoring tools that will hide most if not all of the
markup from the casual user of OSIS. In the meantime, the best way to
learn OSIS is to use a simple text editor, such as WordPad or Kedit
on Windows, BBEdit or Alpha on MacOS, or vi or emacs on Linux. You
can even use a word processor, though any formatting that you do in
it won't matter (you would simply save the file as "text only".
</p>
<p>The examples in this manual have been kept deliberately short and
can be downloaded as a package from the OSIS website. After you have
gained some basic skill at using OSIS, then you may want try out more
sophisticated editors.</p>
</div>
<div><head>Your First OSIS Document</head>
<p>Like HTML documents, an OSIS document starts with a header,
and then goes on to the actual text content. The header identifies
the file as being in XML, and as using the OSIS schema. It also
provides places to declare a bibliographical description of the work
and of any other works cited; and a place to record a history of
editing changes. Here is a very short, but valid, OSIS document:</p>
<eg>
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<osis xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation
="http://www.bibletechnologies.net/osisCore.1.1.1.xsd">
<osisText osisIDWork="CEV" osisRefWork="Bible" lang="en">
<header>
<work osisWork="CEV">
<title>Contemporary English Version</title>
<identifier type="ISBN">1585160555</identifier>
<rights type="copyright">Copyright 1995, 2003
American Bible Society</rights>
<refSystem>Bible</refSystem>
<scope osisRef="John.1.1"/>
</work>
<work osisWork="Bible">
<refSystem>Bible</refSystem>
</work>
</header>
<div type="book" osisID="John">
<title>John</title>
<chapter osisID="John.1">
<title>Chapter 1</title>
<v osisID="John.1.1">In the beginning
was the one who is
called the Word. The Word was with
God and was truly God.</v>
</chapter>
</div>
</osisText>
</osis>
]]>
</eg>
</div>
<div><head>The XML and OSIS declarations</head>
<p>
The first several lines of any OSIS document will generally be identical:
</p>
<p>
The first line above identifies the document as being in XML; this
is required in exactly the form shown, and enables computers to
identify how to process the rest of the document.
</p>
<p>
The second through fourth lines are a very long start-tag for the
outermost OSIS element, which is called "osis".
</p>
<p>
The first attribute, whose name is "xmlns:xsi", refers to a
"namespace" whose name is
"http://www.w3.org/2001/XMLSchema-instance", and declares that later
tags or attributes beginning with the namespace prefix "xsi:" are
drawn from that namespace. This sets things up so the very next
attribute can be recognized as declaring the OSIS schema (set of
elements and attributes) used by the document.
</p>
<p>
The second attribute uses that "xsi:" namespace prefix on a name:
"xsi:noNamespaceSchemaLocation" is a name (from the
"http://www.w3.org/2001/XMLSchema-instance" namespace) that is
defined to mean that later elements and attributes come from the
schema specified as its value. In this case that is the OSIS schema,
which is found at Web location
"http://www.bibletechnologies.net/osisCore.1.1.1.xsd". </p>
<p>If you have a local copy of the schema, you may replace this URI
with a URI that specifies where to find it on your local disk. One
such example might be "file://c/xml/schemas/osisCore.1.5.xsd";
programs vary in whether they want such URIs to start with "file://",
"local://", or nothing; different platforms may also prefer slash,
backslash, or colon to separate directory names. Try various
combinations until you find out what your software likes, and then
remember it for later use.
</p>
<p>
At this point, the OSIS document has begun. In the example above, it
is a single document rather than a collection, so the next element
opened is osisText:
</p>
<eg>
<![CDATA[
<osisText osisIDWork="CEV" osisRefWork="Bible" lang="en">
]]>
</eg>
<p>
Every osisText element needs to supply the osisIDWork attribute to
specify what work any osisIDs within it refer to. This will generally
be the short name of the same work you are encoding, in this case the
Contemporary English Version or CEV. The value on this attribute must
also appear as the value of the osisWork attribute on some work
element in the same osisText.
</p>
<p>
Every osisText also needs to specify what reference or versification
scheme any osisRefs within it refer to. This may or may not be the
same work. Depending on how finely you distinguish things, there are
several major versification traditions, and countless fine-grained
variations. For the present, we identify and reserve names for these
major traditional reference systems:
</p>
<p>
r-NA27 -- as used in most English Bibles, with slight variations.
</p>
<p>
r-Hebrew -- Hebrew tradition varies in several respects, the best
known being that it number the proscriptions above Psalms as verse 1,
and the beginning of the psalm proper as verse 2.
</p>
<p>
r-SamPent -- the Samaritan Pentateuch used a quite different
numbering system.
</p>
<p>
r-Loeb -- This system is used for most classical literature,
though many major works have other systems as well.
</p>
<p>
OSIS is developing a schema for declaring versification systems
formally, and for declaring some systems in terms of others. This
will enable programs to map between systems. However, at this time we
merely reserve the names above for some systems we know to be
substantially different and important.
</p>
</div>
<div><head>Canonical vs. non-canonical parts of a work</head>
<p>
osisText has one other important attribute that is not shown above.
It is called "canonical", and always have a value of "true" or
"false". When true, it asserts that the content is a true part of the
text being encoded. For the Bible, this includes book, chapter, and
verse content in general; but excludes notes, section-headings added
by editors or translators, etc.
</p>
<p>
The canonical attribute is available on all elements. Its value
inherits in the same manner as xml:lang. Because of this inheritance,
ncoders will seldom need to make this attribute explicit. osisText is
declared to assign a default value of "true", while header, note, and
reference override that by defauting the attribute to "false."
</p>
<p>
In books other than the Bible, a similar distinction holds: the text
proper of Herodotus' Histories must be contained in elements with
canonical="true", while notes, header data, and the like must not.
</p>
The canonical attribute only makes assertions about the canonicity of
content. All markup is considered non-canonical, because there was
little explicit markup in ancient texts (other than limited
punctuation), and even that little seldom corresponds directly to
modern markup. One slightly troublesome example is quotation marks;
in a text that had them originally, and they were deleted in favor of
using q or speech elements in an elecronic edition, OSIS presently
provides no way to make that explicit. If this becomes a significant
problem, we will add such a means in a later edition of the OSIS
specification.
<div><head>Meaning of the canonical attribute</head>
<p>
The meaning of this attribute is limited. It must not be used to
encode interpretive or theological judgements about canonicity. For
example, encoders who include the apocryphal books of the Bible, or
the alternate longer ending to the Gospel of Mark, must mark them as
canonical (whether by default or explicitly). This is simply because
they are part of the text being encoded. Users of a text are never
justified in drawing conclusions about a translator's, editor's, or
encoder's position on such questions based on how they set the
canonical attribute, because the attribute does not mean that.
</p>
<p>
In most cases use of the canonical attribute is straightforward, and
we expect that the default values will almost always produce the
intended result. However, there will arise truly difficult cases: for
example, one may be encoding an ancient text with annotations of its
own. In that case those notes would be canonical, while any added by
the current editor would not be. In such cases, the practice chosen
and its rationale should be included in the work's documentation.
</p>
</div>
<div><head>The OSIS text header</head>
<p>
The first element within every osisText must be a header. The header
declares various works (including the work being encoded and any that
are being referenced), and provides a place to keep a revision
history of the text.
</p>
<div><head>The Revision History</head>
<p>
To record changes or edits to the text, authors and editors are
encouraged to insert a revHist element every time significant editing
is done. The revHist element should contain a date element which says
when those edits were completed, in the form
</p>
<eg>
yyyy:mm:ddThh:mm:ss
</eg>
<p>
It is permissible to omit the time and the preceding "T", thus giving
just a date. A date element in the revision history is followed by
any number of p elements, in which the changes made are summarized.
The person responsible for making the changes should also be
identified.
</p>
<p>
Recommended practice is that more recent revHist elements appear
earlier in the document. That is, revHists should occur in reverse
chronological order.
</p>
</div>
<div><head>Work Declarations</head>
<p>
A work declaration provides information comparable to that found
on the title page of a printed work, using the fields defined by the
Dublin Core Initiative.
</p>
<p>The <work> element serves two purposes. The
<hi>first</hi> work element in the <header> element identifies
the work in which it occurs -- much like the title page in a printed
work.</p>
<p>Subsequent <work> elements identify other works -- much
like a citation in a footnote or bibliography in a printed work, and
assign a local name to each one. Works so declared can then be
referred to from osisRefs throughout the document.</p>
<p>
Each work declared must provide a short name on the osisWork
attribute, which can be used to refer to it in osisIDs or osisRefs
throughout the text. For Bibles, this should generally be the
accepted acronym or abbreviated form of the translation's name. No
periods, hypens, or colons are allowed in short names.
</p>
<p>
Each work must also declare whether it is a content work (such as a
BIble, commentary, lexicon, novel, history, etc), or a declaration
work (such as a formal definition of a reference system; a formal
list of characters, authors, places; and so on). This information is
provided on the type attribute, whose value must be given as either
"content" or "declaration".
</p>
<p>
Works must also use the subtype attribute to declare what broad class
of work they fall under, primarily in terms of reference method. The
subtypes defined are Bible, Sacred, Literary, Commentary, Timeline,
Lexicon, and Other. The first four types would normally contain
osisIDs expressing some hierarchical canonical numbering scheme.
Timelines would include any material organized primarily by dates or
times, such as a daily devotional, a lectionary, a historical
timeline, and so on. Lexica are documents primarily organized by
words -- dictionaries, encyclopedias, and the like.
</p>
<p>
It is important to distinguish these kinds of works because each uses
a different syntax for identifiers and references.
</p>
</div>
<div><head>The Dublin Core </head>
<p>Each work element describes a single publication using several
pieces of information, primarily title, creator, date, publisher,
identifier and language. All of the standard "Dublin Core" elements
may be used, plus a few OSIS-specific additions (further information
on the Dublin Core system may be found at dublincore.org. All of the
Dublin core fields are repeatable. For example:</p>
<eg>
<![CDATA[
<work osisWork="EG" type="content" subType="lexicon">
<title>Egyptian Grammar</title>
<creator role="aut">Alan Gardiner</creator>
<contributor role="dte">Francis Llewellyn Griffith</contributor>
<date type="original">1927</date>
<date type="eversion">2003</date>
<type>Bible</type>
<publisher>Griffith Institute, Ashmolean Museum, Oxford</publisher>
<language type="ISO-639">EN</language>
<language type="Ethnologue">EG-ancient</language>
<identifier type="ISBN">0900416351</identifier>
<identifier type="LCCN">95230980</identifer>
</work>
]]>
</eg>
<div><head><title></head>
<p>Title elements in the work element contain the main title of the
work. The type attribute can be used to specify a classification of a
title, such as a subTitle, monographicSeriesTitle, etc. but no OSIS
specific types are established for this attribute.</p>
</div>
<div><head><creator></head>
<p>The <creator> element is used to specify the person(s) or
organization(s) who are primarily responsible for the intellectual
content of a work. The role attribute must specify the particular
role the primary respojnsible party played. The most common values
would be
aut (author), edt (editor), cmm (ommentator), trl (translator).
</p>
</div>
<div><head><contributor></head>
<p>Many people may contribute to a work in roles other than the
primary role listed under creator. They should be listed using the
<contributor> element. Their specific role should be recorded
in the role attribute of their contributor element. A very complete
list of role codes provided by the USMARC organization, is included
in an appendix.</p>
</div>
<div><head>date</head>
<p>Date elements in the work element record significant dates in
the production or publication process. Use the type attribute to type
of date contained in each the date element. Those types are:</p>
<list type='definition'>
<label> original</label>
<item> The original publication date of the first
edition</item>
<label> edition</label>
<item> The date of publication of the referenced
edition</item>
<label> imprint</label>
<item> The printing date of the referenced edition</item>
<label> eversion</label>
<item> The revision date, if any, of a referenced
electronic edition</item>
</list>
</div>
<div>
<head><publisher></head>
<p>Publisher elements in the work element use the type attribute to
specify which particular publisher is identified in that element. For
example, the original and later editions of a work may have different
publishers, as may reprints or digital editions. The publisher types
are the same as the date types.</p>
</div>
<div><head>language</head>
<p>A language element must be provided for each language used
substantially in a work. The language may be specified using an ISO
639 or ISO 639-2, or SIL Ethnologue codes. The type attribute must be
set to "ISO-639," "ISO-639-2," or
"SIL," respectively. In the rare case that none of these is
sufficient, a prose description should be inserted in the element and
the type set to other.</p>
</div>
<div><head>type</head>
<p>
The nature or genre of the content of the resource. This element
includes terms describing general categories, functions, genres, or
aggregation levels for content. Dublin Core's recommended best
practice is to select a value from a controlled vocabulary (for
example, the DCMI Type Vocabulary [DCT1]). OSIS does not provide such
a controlled vocabulary at this time. If you encode this element, the
controlled vocabulary in use should be identified via the type
attribute (thus, <type type="...">). To describe the physical
or digital manifestation of the resource, use the FORMAT element
instead.
</p>
</div>
<div><head>identifier</head>
<p>The identifier elements provide one or more formal identifiers
for the work. Common types of identifier are International Standard
Book Numbers, Library of Congress Control Number, or Serial Item and
Controbution Identifier. Recommended values for the identifier type
attribute are: "ISBN," "SICI" (A SICI is an ISSN
with fields added to identify a particular issue of the serial
publication, and a particular article or other contribution within
that issue), "LCCN,", and "PURL."</p>
<p>ISBN and LCCN numbers must be recorded without spaces or hyphens.
ISBNs must contain ten digits (that is, they must include the final
check digit).</p>
<p>We strongly recommend the assignment of an ISBN to each
published work using OSIS. This number must, if available, be
specified in the identifier field for the work. </p>
</div>
<div><head>coverage</head>
<p>This element may be used to specify the spatial location (a place
name or geographic coordinates), temporal period (a period label,
date, or date range) or jurisdiction (such as a named administrative
entity) to which the work applies. For example, an edition of
Herodotus could be specified as Greek/Hellenic, Classical Period. Or
a study of medieval Bibles could declare coverage as "medieval".</p>
</div>
<div><head>description</head>
<p>
An account of the content of the resource.</p>
<p>Examples of Description include, but is not limited to: an
abstract, table of contents, reference to a graphical representation
of content or a free-text account of the content.
</p>
</div>
<div><head>format</head>
<p>
The physical or digital manifestation of the resource.</p>
<p>Typically, Format may include the media-type or dimensions of the
resource. Format may be used to identify the software, hardware, or
other equipment needed to display or operate the resource. Examples
of dimensions include size and duration. Recommended best practice is
to select a value from a controlled vocabulary (for example, the list
of Internet Media Types [MIME] defining computer media formats).
</p>
</div>
<div><head>relation</head>
<p>
A reference to a related resource.</p>
<p>Recommended best practice is to identify the referenced resource
by means of a string or number conforming to a formal identification
system.
</p>
</div>
<div><head>rights</head>
<p>
Information about rights held in and over the resource.</p>
<p>Typically, Rights will contain a rights management statement for
the resource, or reference a service providing such information.
Rights information often encompasses Intellectual Property Rights
(IPR), Copyright, and various Property Rights. If the Rights element
is absent, no assumptions may be made about any rights held in or
over the resource.
</p>
</div>
<div><head>subject</head>
<p>
A topic of the content of the resource.</p>
<p>Typically, Subject will be expressed as keywords, key phrases or
classification codes that describe a topic of the resource.
Recommended best practice is to select a value from a controlled
vocabulary or formal classification scheme.
</p>
</div>
<div><head>source</head>
<p>
A Reference to a resource from which the present resource is derived.</p>
<p>The present resource may be derived from the Source resource in
whole or in part. Recommended best practice is to identify the
referenced resource by means of a string or number conforming to a
formal identification system.
</p>
</div>
<div><head>type</head>
<p>
The nature or genre of the content of the resource.</p>
<p>Type includes terms describing general categories, functions,
genres, or aggregation levels for content. Recommended best practice
is to select a value from a controlled vocabulary (for example, the
DCMI Type Vocabulary [DCT1]). To describe the physical or digital
manifestation of the resource, use the FORMAT element.
</p>
</div>
</div>
<div><head>Non-Dublin Core Elements and Attributes in the Work
Declaration</head>
<div><head>scope</head>
<p>The scope element must include an osisRef attribute, which defines
what part of the titled work occurs in this electronic edition. For
example, an edition may consist of only the New Testament and Psalms,
or of only a single book.</p>
<p>If the range contained in the work is not contiguous, multiple
instances of the scope element must be used to specify the complete
scope. There should be, but are not required to be, in canonical
order.
</p>
</div>
<div><head>osisWorkType attribute</head>
<p>The work element must include the type attribute, which is used to
define the broad class of the work as either:</p>
<list>
<label>content</label><item>A work of actual content, such as a Bible
or commentary, intended to be read or otherwise processed by
people.</item>
<label>declaration</label><item>A work containing machine-processable
information, such as the formal declaration of a reference system, or
a normative list of names to be referenced from other works.</item>
</list>
<p>
When type="content", the subType attribute must be one of:
</p>
<list>
<label>Bible</label><item>The work is a Bible or portion</item>
<label>Commentary</label><item>The work is an expository of
theological work.</item>
<label>Lexicon</label><item>The work is a glossary, dictionary, or
other reference work organized by lexical entries.</item>
<label>Literary</label><item>The work is one of religious or secular
literature.</item>
<label>Sacred</label><item>The work is a sacred work other than the
Bible.</item>
<label>TimeLine</label><item>the work is a reference work organized
by dated entries, such as a devotional, historical timeline, diary,
or the like.</item>
<label>Other</label><item></item>
</list>
<p>
When type="declaration", the subType attribute must be one of those
shown below (the schemas for such documents have not yet been
released by BTG):
</p>
<list>
<label>RefSystem</label><item>The work declares a reference system</item>
<label>RefSystemMap</label><item>The work declares a mapping between
reference systems</item>
<label>NameList</label><item>The work declares a normative list of
names for some use (such as Bible book names, person/place/feat
names, etc).</item>
<label>Other</label><item></item>
</list>
</div>
</div>
</div>
</div>
<div><head>Identifying a Work given a work declaration element</head>
<p>The six elements already described are the primary means of
identifying a referenced work.</p>
<p>If a publication matches all of the above elements within work, it
is presumed to be an acceptable resolution for any reference to that
work as declared.</p>
<p>If no perfect match can be found, applications may, indeed should,
attempt to fall back to the closest available publication. OSIS does
not define a required method of fallback, or define what "closest"
must mean in all contexts. HOwever, one possible approach is to
successively ignore particular elements in this order:</p>
<list>
<label>Identifier</label><item>because identifiers are often
ambiguous. For example, hardcover and softcover editions of a book
typically have different ISBNs, and occasionally publishers re-use an
old ISBN for a completely different book.</item>
<label>Date</label><item>because a different imprint or edition of
the same conceptual work is typically adequate. Precisely targeted
links, however, may not refer to the exact location desired.
Applications may wish to ignore all dates except for the original
publication date.</item>
<label>Publisher</label><item>because several publishers may
publish a given work (particular older works), publishers may change
name, etc.</item>
<label>Language</label><item>Accepting a publication that does
not match in language is a substantial concession. However, some
variations of language are greater than others. For example, some
modern Bible translations are available in separate American and
British English versions, and substituting one for the other is not
unreasonable. This is particularly true because translations
generally use translated titles as well, and so if the language is
not closely related, the title will probably not match either.
Applications may wish to encode some knowledge of language and
dialect similarities to implement more sophisticated fallback.</item>
<label>Creator</label><item>because some authors have multiple
forms of name: St. Augustine vs. Augustine of Hippo vs. Augustine vs.
. The Bible Technology Group intends to develop an authority list of
normative name-forms for relevant authors, and once such a list is
available, using it will help to avoid such problems. As with other
elements, more sophisticated applications may wish to attempt some
kind of approximate matching in order to achieve better
fallback.</item>
<label>Title</label><item>the final item to discard is probably
title. If a work's title differs, it is probably a different work, or
at least a translation into a non-close language. On the other hand,
some titles have been used by multiple authors, and so a match on
title alone should be considered suspect.</item>
</list>
<p>Arguments can easily be made for a variety of other fallback
methods. For example, if the identifier element matches, the work is
probably right, even though an identifier mismatch is not good
evidence that the work is wrong.</p>
</div>
<div><head>Date formats</head>
<p>
All dates in the header and in attributes should be in this standard
format, which is based on IETF RFC 3339 but adds features to allow
for dates BCE, for approximate dates, for date ranges, for yearless
date (as used in many daily devotionals), and for named times (such
as used in many prayer books). The basic date format is:
</p>
<eg>
yyyy:mm:ddThh:mm:ss
</eg>
<p>Any number of fields may be left off from the right end; for
example, if the seconds are dropped (along with the preceding colon),
the time refers to the entire minute specified; if the entire time
section is left off (along with the preceding "T"), the string refers
to the entire day.</p>
<p>The year must always have 4 digits, but may be preceded by a
hyphen to indicates years before the common era. Alternatively, the
year may be entirely omitted, in order to indicate dates that apply
to any year, such as in a book of 365 daily readings.</p>
<p>The entire date/time string (possibly including a leading hyphen)
may be preceded by "~", indicating that the time is approximate. No
means is provided to express just how approximate a time may be.</p>
<p>Finally, a small set of named times is provided, which can be
specified in place of the entire (post-"T") time section. For
example:</p>
<eg>
06:04T~(Vespers)
</eg>
<p>would be the identifier for a prayer, reading, or other work to be
used at vespers on June 4 of any year. The named times (which are
case-sensitive) include: Vigils, Matins, Lauds, Terce, Sext, None,
Vespers, Compline; Sunrise, Sunset; Morning, Afternoon, Evening,
Night; AM, PM;
Fajr, Zuhr, _Asr, Maghhrib, _Isha, Lail, Dzuha, _Id.</p>
<p>Some works will be primarily organized by dates and times: for
example, lectionaries, daily devotionals, prayer books, historical
time lines, etc. In such works, use the timeID attribute instead of
the osisID attribute to identify the retrievable portions; the value
should the the applicable time in the format just shown.</p>
<p>Typically, such works are organized in order of the times
specified; however, OSIS does not impose that requirement.</p>
</div>
<!-- ============================================================== -->
<div><head>Basic Elements</head>
<p>
While book, chapter, and verse numbers are a familiar and useful way
of referring to locations in the Bible, they often conflict with the
boundaries of parables, stories, genealogies, paragraphs, quotations,
and other important units of understanding that must also commonly be
marked. They are also a quite late addition, and are specific to the
Bible.
</p>
<p>
It is possible to encode a Bible using only book, chapter, and verse
markup. However, most encoders want to also represent sections,
paragraphs, quotations, and so on. Higher-level structures are tagged
as <div>, for "division", with a type attribute to specify the
particular significance. divs can occur within divs to any number of
levels. The first and outermost div should occur immediately after
the end of the header. For example,
</p>
<eg>
<![CDATA[
<div type="book" osisID="Gen">
<head>Genesis</head>
<chapter osisID="Gen.1">
<head>1</head>
<v osisID="Gen.1.1">In the beginning,...</v>
<v osisID="Gen.1.2">The earth was formless and void...</v>
...
</div>
</div>
]]>
</eg>
<p>
The div element makes heavy use of the type attribute. The
pre-defined types include the most common major division found in
present-day Bibles and related works:
</p>
<blockquote>
<p>
acknowledgement, afterword, appendix, back, body, book, bookGroup,
colophon, commentary, concordance, coverPage, dedication, devotional,
entry, front, gazetter, glossary, imprimatur, index, introduction,
majorSection, map, outline, preface, section, subSection, titlePage.
</p>
</blockquote>
<p>
The main body of a Bible will typically consist of divs of type
bookGroup (such as each Testament, the Apocrypha, and perhaps smaller
groups such as the Pentateuch, the Minor Prophets, etc), book, the
majorSections (such as the sub-books in Psalms), sections (typically
headed topical divisions), subSections (occasional minor divisions
within sections), and then break down into paragraphs, lists,
quotations, inscriptions, and the like.
</p>
<p>
Such markup forms the primary backbone of an OSIS document. chapter
and verse elements are important, but considered to be an overlay
onto the more linguistic or thematic structure. Therefore, so long as
verses and chapter do not cross the boundaries of other elements,
they may be expressed in the normal fashion (NASB):
</p>
<eg>
<![CDATA[
<chapter osisID="Mark.10">
<head>Mark Chapter 10</head>
<div type="section"><head>Divorce</head>
<verse osisID="Mark.10.1">Jesus then left that place and went into
the region of Judea and across the Jordan. Again crowds of people
came to him, and as was his custom, he taught them.
</verse>
<verse osisID="Mark.10.2">Some Pharisees came and tested him by
asking, "Is it lawful for a man to divorce his wife?"
</verse>
<verse osisID="Mark.10.3">"What did Moses command you?" he replied.
</verse>
<verse osisID="Mark.10.4">They said, "Moses permitted a man to write
a certificate of divorce and send her away."
</verse>
<verse osisID="Mark.10.5">"It was because your hearts were hard that
Moses wrote you this law," Jesus replied. </verse>
<verse osisID="Mark.10.6">"But at the beginning of creation God 'made
them male and female.'[</verse>
<verse osisID="Mark.10.1">] </verse>
<verse osisID="Mark.10.7">'For this reason a man will leave his
father and mother and be united to his wife,</verse>
<verse osisID="Mark.10.8">and the two will become one flesh.' So they
are no longer two, but one. </verse>
<verse osisID="Mark.10.9">Therefore what God has joined together, let
man not separate."
</verse>
<verse osisID="Mark.10.10">When they were in the house again, the
disciples asked Jesus about this. </verse>
<verse osisID="Mark.10.11">He answered, "Anyone who divorces his wife
and marries another woman commits adultery against her. </verse>
<verse osisID="Mark.10.12">And if she divorces her husband and
marries another man, she commits adultery."
</div><!-- end of section -->
...
</chapter>
]]>
</eg>
</div>
<div><head>Simple paragraphing, quotes, and notes</head>
<p>Paragraphs and other grouping elements can be inserted around
groups of verses, as shown below. Likewise, quotes and notes can be
inserted where needed. The paragraph need not give an osisID for the
set of verse it contains:</p>
<eg>
<![CDATA[
...
<p>
<verse osisID="Esth.4.10">Then Esther spoke to Hathach, and gave him
a command for Mordecai: </verse>
<verse osisID="Esth.4.11"><q>All the king's servants and the people
of the king's provinces know that any man or woman who goes into the
inner court to the king, who has not been called, he has but one law:
put all to death, except the one to whom the king holds out the
golden scepter, that he may live. Yet I myself have not been called
to go in to the king these thirty days.</q> </verse>
<verse osisID="Esth.4.12">So they told Mordecai Esther's words.
</verse> </p>
<p>
<verse osisID="Esth.4.13">And Mordecai told them to answer Esther:
"Do not think in your heart that you will escape in the king's palace
any more than all the other Jews. </verse>
</p>
<p>
<verse osisID="Esth.4.14">For if you remain completely silent at this
time, relief and deliverance will arise for the Jews from another
place, but you and your father's house will perish. Yet who knows
whether you have come to the kingdom for such a time as this?"
</verse>
</p>
<p>
<verse osisID="Esth.4.15">Then Esther told them to reply to Mordecai: </verse>
<q>
<verse osisID="Esth.4.16">"Go, gather all the Jews who are present in
Shushan, and fast for me; neither eat nor drink for three days, night
or day. My maids and I will fast likewise. And so I will go to the
king, which is against the law; and if I perish, I perish!</q>
</verse>
</p>
<p><verse osisID="Esth.4.17">So Mordecai went his way and did according to
all that Esther commanded him.<note type="textual">Septuagint adds a
prayer of Mordecai here.</note></verse> </p>
]]>
</eg>
<p>
Notice in this example that all the paragraphs and quotations still
enclose an exact number of verses; there are exceptions to this to be
handled as explained later.
</p>
<p>
When tagging quotations, do not also include quotation marks. They
will be generated in the typesetting or display process. This is
important for several reasons. FIrst, if some people use <q>,
some use punctuation marks, and some use both, anyone processing OSIS
texts will have to check every text and account for all the
variations -- this is expensive and time-consuming: that is, it will
make the Bibles cost more (to someone), and be delivered later.
Another reason is that punctuation for quotes differs around the
world; so any given quotation mark may be meaningless to other
communities. In Spanish, for example, there are special rules about
how to mark quotes that continue after an interruption -- such cases
can be distinguished by adding a type attribute to the q element,
with values such as "initial", "medial", and "final".
</p>
<p>
Many editions of the Bible have accompanying notes. It is customary
to include the notes directly within the text, at the point to which
they apply. This can be done via the note element, which can be
placed almost anywhere. In the future, it is likely that notes will
more commonly reside outside of the text, instead residing in special
notes-files that can be attached to any Bible edition on request.
</p>
<p>
Every note should have a type attribute to indicate its purpose; many
Bible editions show different kinds of notes in different places. The
pre-defined note types are listed below; they are not
sharply-defined, wholly distinct categories. In addition, if none of
these categories suffice, encoders may create their own so long as
their names begin with "x-".
</p>
<list type='definition'>
<label>allusion</label>
<item>The note explains an implicit reference the
text makes to another text or concept.</item>
<label>alternative</label>
<item>The note records an alternate possible reading
of the text, whether due to ambiguity in translation or to manuscript
variation.</item>
<label>background</label>
<item>The note provides background information, such
as cultural norms, explanations of geographic or other information
original readers would have known, and so on.</item>
<label>citation</label>
<item>The note cites a supporting text or further
explanation of some kind.</item>
<label>crossReference</label>
<item>The note provides a cross-reference to a
related passage or other text.</item>
<label>devotional</label>
<item>The note includes information of interest for
devotional reading.</item>
<label>exegesis</label>
<item>The note discusses a relevant point of exegesis
or interpretation</item>
<label>explanation</label>
<item>The note explain implicit, ambiguous, or
otherwise non-obvious aspects of the passage.</item>
<label>study</label>
<item>The note provides helps for a deeper study of
the passage.</item>
<label>translation</label>
<item>The note discusses an issue of translation,
such as a word whose meanining is unclear in the original, or a
reasons for the translator's choice of phrasing. Bible translation
projects will likely use this heavily, using the subtype attribute to
mark the status of each note as resolved or unresolved, the person
responsible for the note, and so on.</item>
<label>variant</label>
<item>The note records a textual variation in
manuscript tradition, relevant at its location.</item>
</list>
<eg>
<![CDATA[
]]>
</eg>
<p>Sometimes a verse or chapter starts or end in the middle of some
other unit, such as a poetic line group, paragraph, quotation, or
speech. In such cases an alternate form of the v or chapter tag must
be used. This usage is explained in a later section.</p>
</div>
<div><head>Elements that cross other elements</head>
<p>The normal form of an element is a start tag and an end tag:
<verse>...</verse>. The special form for handling markup
that crosses boundaries, however, consists of two totally empty
instances of the same element type: one to mark the starting point,
and one to mark the ending point. The two empty tags identify
themselves as to which is the start and which is the end, and
co-identify themselves via an ID-like attribute they must share:</p>
<eg>
<v sID="xyz237"/>....<v eID="xyz237"/>
</eg>
<p>
This is equivalent to the TEI "milestone" method for marking such
phenomena. It has the advantage that milestones representing a given
type of element have the same name as the element, and automatically
may have the same attributes. Althoug XML will not detect a
validation error if attributes other than eID are specified on the
ending milestone, or if eID is specified on the starting milestone,
each is an OSIS error and must not be done.
</p>
<p>
For OSIS purposes, there is no semantic difference between marking up
a chapter or verse as a container using a start and end tag, versus
marking it up as a "milestone pair" consisting of two empty tags.
</p>
</div>
<!-- ==================================================================== -->
<div><head>The rest of the elements</head>
<p>The bulk of the remaining OSIS elements fall into various classes:
First, those that mark commomplace units such as paragraphs, lists,
and the occasional table and glossary (typically found in appendixes
of printed Bibles). Second, markup for special text types, such as
epistles and drama. And finally, small-scale elements that mark,
quotations, notes, names, and the like.</p>
<div><head>Markup for epistles and similar materials</head>
<p>
Letters, epistles, and similar texts are marked up in basically the
same way as any other text. However, three special elements are
available for marking portions unique to this genre:
</p>
<div><head>salute </head>
<p>The salute element enclosed the salutation or greeting, typically
at the very beginning of a letter. It should include the whole
salutation, including (if present) the "to", "from", and any
following greeting or blessing. If the bounaries of a salutation are
the same as the boundaries of a paragraph, section, or other unit,
that unit should be placed outside, with the salute element directly
within. For example:
</p>
<eg>
<![CDATA[
<div type="book" osisID="1Tim">
<head>The First Epistle to Timothy</head>
</div>
]]>
</eg>
</div>
<div><head>closer </head>
<p>The closer element surrounds the closing portion of a letter,
typically consisting of final greetings or blessing, and a signature
(see signed).
</p>
<eg>
<![CDATA[
]]>
</eg>
</div>
<div><head>signed </head>
<p>The signed element surrounds only the name signed at the end of a
letter. It may appear with or without an accompanying closer element.
For example:
</p>
<eg>
<![CDATA[
]]>
</eg>
</div>
</div>
<div><head>Dramatic texts</head>
<p>
OSIS provides two main features for marking up dramatic texts: A way
to declare the list of characters, or castList; and a way to identify
speeches and speakers in the body of a dramatic text.
</p>
<p>
A castList element contains a structured list of the roles, or cast,
of a dramatic work. It is drawn directly from the TEI structure for
the same thing. For example, in the Song of Songs, some translations
may present the list of characters at the start of the book: lover,
beloved, and friends. The same might be done for Job. However, these
elements will be most commonly used for extra-Biblical materials,
such as a play based on the Bible, or dramas in classical or other
literature.
</p>
<p>
A simple example of a castList is shown below, perhaps for a dramatic
re-enactment of Job:
</p>
<eg>
<![CDATA[
<castList>
<castGroup>
<head>Cast of characters</head>
<castItem>
<actor>Patrick Durusau</actor>
<role>Job</role>
<roleDesc>A man of God who suffers greatly</roleDesc>
</castItem>
<castItem>
<actor>(a whirlwind)</actor>
<role>God</role>
<roleDesc>The Almighty, who permits Job's suffering, and
responds to his questions about it.</roleDesc>
</castItem>
<castItem>
<actor>(a disembodied voice)</actor>
<role>Satan</role>
<roleDesc>The instigator of Job's suffering</roleDesc>
</castItem>
<castItem>
<actor>Todd Tillinghast</actor>
<role>Eliphaz</role>
<roleDesc>The first of Job's friends to speak</roleDesc>
</castItem>
<castItem>
<actor>Chris Little</actor>
<role>Bildad</role>
<roleDesc>The second of Job's friends to speak</roleDesc>
</castItem>
<castItem>
<actor>Steve DeRose</actor>
<role>Zophar</role>
<roleDesc>The third of Job's friends to speak</roleDesc>
</castItem>
<castItem>
<actor>Troy Griffiths</actor>
<role>Elihu</role>
<roleDesc>The youngest and last of Job's friends to speak,
who was slightly less clueless than the rest.</roleDesc>
</castItem>
</castGroup>
</castList>
]]>
</eg>
<p>
The castList element contains the entire casting List, and consists
of one or more castGroup elements. Multiple castGroups, each with its
own head, would be used if there were multiple sub-groups of the cast
to be listed separately.
</p>
<p>
At this time, castList can only occur in the work declaration, after
the Dublin Core elements. Thus, if a Bible encoder wishes to include
the casts of Song of Songs and of Job, they should each need to be
marked as a separate castGroup within that one castList.
</p>
<p>
The castItem element contains the full information for a single
character. This must include a name for the role being played, and
should include a description of that role. It may also include the
name of an actor, if the text being encoded represents a particular
enactment rather than, say, a libretto or script.
</p>
<p>
In general there is no need to also encode an actor name or role name
with an explicit name, unless the encoder wishes to provide a
normalized form for later reference; in that case, the name element
would be place just within the actor or role element, not surrounding
it.
</p>
<p>
It is strongly recommended that each castGroup and castItem have an
ID attribute. Since IDs must be unique across all element types in a
document, encoders may wish to prefix certain kinds of IDs to
separate them and avoid conflicts. For example, an appropriate ID for
castItem representing the Friends in Song of Songs would be
"cast.friends", or perhaps "cast.song.friends".
</p>
</div>
<div><head>speaker </head>
<p>The speaker element is used to identify the person or role that is
uttering the content of an associated speech.
</p>
</div>
<div><head>speech </head>
<p>The speech element is used to indicate quoted direct speech. In
that sense it represents a kind of quotation. However, the q element
is to be used for quotations in general, where the speech element is
limited to accounts of an individual making an actual speech in some
kind of performance context. Just as with the q element, using the
speech element makes quotation marks unnecessary, and they must not
be used. For example:
</p>
<eg>
<![CDATA[
<chapter osisID="Acts.7">
<head>Stephen's Speech to the Sanhedrin</head>
<p>
<verse osisID="Acts.7.1">Then the high priest asked him, <speech>Are
these charges true?</speech>
</verse>
</p>
<p>
<verse osisID="Acts.7.2">To this he replied: <speech>Brothers and
fathers, listen to me! The God of glory appeared to our father
Abraham while he was still in Mesopotamia, before he lived in Haran.
</verse>
<verse osisID="Acts.7.3">'Leave your country and your people,' God
said, 'and go to the land I will show you.'</verse>
</p>
<p>
<verse osisID="Acts.7.4">"So he left the land of the Chaldeans and
settled in Haran. After the death of his father, God sent him to this
land where you are now living. </verse>
<verse osisID="Acts.7.5">He gave him no inheritance here, not even a
foot of ground. But God promised him that he and his descendants
after him would possess the land, even though at that time Abraham
had no child. </verse>
<verse osisID="Acts.7.6">God spoke to him in this way: 'Your
descendants will be strangers in a country not their own, and they
will be enslaved and mistreated four hundred years. </verse>
<verse osisID="Acts.7.7">But I will punish the nation they serve as
slaves,' God said, 'and afterward they will come out of that country
and worship me in this place.'</verse>
<verse osisID="Acts.7.8">Then he gave Abraham the covenant of
circumcision. And Abraham became the father of Isaac and circumcised
him eight days after his birth. Later Isaac became the father of
Jacob, and Jacob became the father of the twelve
patriarchs.</verse></p>
...
<verse osisID="Acts.7.51">"You stiff-necked people, with
uncircumcised hearts and ears! You are just like your fathers: You
always resist the Holy Spirit! 52Was there ever a prophet your
fathers did not persecute? They even killed those who predicted the
coming of the Righteous One. And now you have betrayed and murdered
him-- 53you who have received the law that was put into effect
through angels but have not obeyed it."</verse>
...</chapter>
]]>
</eg>
</div>
<!--
<eg>
<![CDATA[
]]>
</eg>
-->
<div><head>milestone </head>
<p>
The milestone element is an empty element, and so is represented as
<milestone/> rather than as a typical start- or end-tag. It is
used to mark point events in a text, often involving the layout of
the original text, or special points of access into the electronic
text.
</p>
<p>
For example, when digitizing a manuscript, it may be considered
important to record where the page, column, and line boundaries of
the original manuscript fell. This would be done as shown here:
</p>
<eg>
<![CDATA[
<milestone type="pb" n="37-verso"/>
<p>The Lord said to Eliphaz:<milestone type="line"/>
What my servant Job has said about me is true, <milestone type="line"/>
but I am angry with you and your two friends for <milestone type="line"/>
not telling the truth. <verse osisID="Job.42.8">So I want you to go
over to <milestone type="line"/>
Job and offer seven bulls and seven goats on an <milestone type="line"/>
alter as a sacrifice to please me. After this, Job <milestone type="line"/>
will pray, and I will agree not to punush you for <milestone
type="line"/>your foolishness.</verse><milestone type="line"/>
<verse osisID="Job.42.9">Eliphaz, Bildad, and Zophar obeyed the Lord,
and he answered Job's prayer.</verse>
]]>
</eg>
<p>
Note that because milestone is an empty or point element, not a
container, it may be placed freely without concern about violating
the boundaries of other elements in the same region.
</p>
<p>
Where a break to be represented by a milestone occurs between other
units, such as verses or paragraphs, the milestone should be placed
between those units, rather then just within either.
</p>
<p>When setting attribute n on a milestone, it should indicate the
number of the unit starting, not the unit ending. For example,
<milestone type="page> n="3"/> indicates the break between
pages 2 and 3, not between pages 3 and 4. Numbering does not need to
be unique across various types of milestones -- for example, the 24th
line on page 5 of a manuscript may be marked simpley n="5", rather
than n="24.5" or similar.</p>
Several predefined types are provided for the milestone element:
<list>
<label>pb</label>
<item>Marks the location of a page break in the source text.</item>
<label>column</label>
<item>Marks the location of a column break in the source text. The
start of the first column need not be marked unless something else
(such as a footer) precedes it in the encoding of the page. Columns
should be numbered in the order of reading (for example, right to
left in Hebrew texts). In the case of, say, an English/Hebrew diglot
edition, where there is no principled order of reading among the
columns, the direction used for the pages (Hebrew or Greek) should be
considered the dominant direction, and the same direction should be
used for numbering columns.</item>
<label>header</label>
<item>A milestone of type "header" should precede the encoding of the
page header if it is being included in the encoded text. This would
normally be true only for digitized editions of manuscripts or other
important copy editions, because in modern print Bibles headers are
typically automatically generated.</item>
<label>footer</label>
<item>Type "footer" should be used just like type "header", except
that it marks the page footer area instead.</item>
<label>line</label>
<item>Line milestones should be used to mark line breaks in the copy
text when they are considered significant. This will normally only be
true for important manuscripts, where line numbering may be needed
for paleographic or reference use. Line milestones must not be used
to represent linguistically significant line breaks, such as in
poetry, for which the lg and l elements are provided.</item>
<label>halfLine</label>
<item>In certain languages it is important to mark half-line units,
and this type is provided for such cases.</item>
<label>screen</label>
<item>The milestone of type "screen" is to be used to mark preferred
break points in an on-screen rendering of the text. For example, if
the user requests to be taken to the book of Psalms in a given
electronic edition, it may be best not to take them to Psalm.1.1, but
to an earlier point, preceding any introductory material. In many
cases this can be accomplished by taking them to the appropriate div
(since the <div type="book" osisID="Ps"> should precede and
Psalms-specific introductory material); but this milestone type is
available for other cases. The OSIS specification does not impose
requirements on how applications make use of such milestones.</item>
</list>
</div>
<div><head>milestoneStart and milestoneEnd</head>
<p>These elements are deprecated (that is, we strongly recommend
against their use). They represent an earlier version's way of
marking up elements that cross other element's boundaries.
</p>
<p>
In OSIS versions prior to 1.5, an element that crossed another's
boundary, such as a quote crossing a paragraph boundary, could be
encoded like this:
</p>
<eg>
<![CDATA[
]]>
</eg>
</div>
<div><head>Marking up poetic material</head>
<p>
Although poetic material is commonly called "verse" material, OSIS
avoids that term because of potential confusion with the
book/chapter/verse reference system. Thus, like TEI, markup of poetry
refers to lines and line groups.
</p>
<p>
In addition, OSIS provides a typographic line-break element. This is
because in at least some editions of the Bible, the exact placement
of typographic line-breaks within poetic lines is considered very
important; while on the other hand it is determined in part by
presentational concerns (for example, column width), rather than by
linguistic characteristics of either the source or target language.
</p>
<p>
OSIS provides three main elements for marking up poetic material:
</p>
<div><head>lg </head>
<p>The lg or "line group" element is used to contain any group of
poetic lines. Thus it covers for units like couple, stanza, and
entire poem. Line groups can contain smaller line groups as well.
</p>
</div>
<div><head>l </head>
<p>The l element is used to mark poetic lines, as determined by the
linguistic nature of poetry in the language of the work. For example,
much English poetry consists of lines that can be located by the
position of rhyming words, and/or by counting syllables; Hebrew poety
can often be divided into lines based on parallelism of thought or
meaning.
</p>
</div>
<div><head>lb </head>
<p>The lb element, or "line break", is used to mark line breaks that
are not the result of linguistically or poetically significant
structure, but are primarily part of the typography and layout. For
example, a lone line might be broken to fit into a narrow column. The
lb element is an empty element used to mark where such breaks
occurred in an important copy text, or where they should be placed in
a text to be rendered.
</p>
<p>
Bible typesetting has a long tradition involving placement of such
breaks. In some cases, translators have carefully decided preferred
or required break-points for various set widths. These can be
accommodated by using the type attribute of lb. For example,
type="wide-pref" and type="narrow-pref" might be used to identify the
locations of preferred line-breaks for wide and narrow column
layouts. Similarly, type might be used to distinguish various levels
of indentation following the break, or other typographic factors
deemed important.
</p>
<p>
The lb element should not be used merely to record where line breaks
in general happened to occur in a source edition. For most source
editions this information is unimportant; for manuscripts it may be
imortant, but must be marked up using the milestone element instead.
</p>
</div>
</div>
<div><head>Lists, tables, genealogies, figures and other material</head>
<p>
Simple glossaries such as appear at the back of many Bibles, may be
encoded at this time using the simple list/label/item elements
described below. A dicitonary extension is well along in development,
and should be available as an extension module within the next few
months. That module should be used for any but the simplest lexical
tools; and once available, OSIS may decide to recommend against
further use of list to represent even simple glossaries.
</p>
<div><head>list </head>
<p>All types of lists are marked using the list element; they can be
distinguished by type attribute valuess such as "ordered",
"unordered", "compact", "definition", and type. A list consists of
any number of items, some or all preceded by labels, which
corresponded to the definition-terms of definition lists in various
schemas.
</p>
</div>
<div><head>label </head>
<p>A leading label for a given list item. Labels are optional.
</p>
</div>
<div><head>item </head>
<p>The main content or description for each list item.
</p>
</div>
<div><head>table </head>
<p>OSIS provides only very rudimentary tables: a table consists of
rows, which in turn consist of cells. Formatting and layout is not
part of the table markup; it can either be done automatically, as in
HTML browsers, or by inserting some signal to the layout engine, such
as type attributes or processing instructions.
</p>
</div>
<div><head>row </head>
<p>
</p>
</div>
<div><head>cell </head>
<p>
</p>
</div>
<div><head>figure </head>
<p>
</p>
</div>
<div><head>caption </head>
<p>
</p>
</div>
</div>
<div><head>a </head>
<p>The a element is exactly analogous to the HTML a element, and
likewise may be used to encode links within a document. This eases
integration of OSIS documents into the Web environment.
</p>
</div>
<div><head>index </head>
<p>The index element may be place at any point in the document to
indicate a topic under which that location should be indexed.
Multiple indexes (such as of places, names, theological or ethical
issues, etc) must be distinguished via the "name" attribute. The
primary index entry name is specified on the "level1" attribute, with
sub-level level2, level3, and level4 also available.</p>
<p>There is also a "see" attribute, which may be used to represent
the need for a cross-reference to another index entry; such elements
should be placed at the end of the document body (since they do not
refer to a particular location).
</p>
</div>
<div><head>reference </head>
<p>
</p>
</div>
<div><head>abbr </head>
<p>Marks a portin of the content as an abbreviation. The expanded
value should be supplied as the value of the expansion attribute.
</p>
</div>
<div><head>catchWord </head>
<p>Catchwords and catchphrases are those parts of notes that are
copied from the main text, to orient the reader as to the note's
precise applicability. Catchwords in notes must be marked when
present.
</p>
</div>
<div><head>divineName </head>
<p>divineName is only for the Deity. Angels, demons, idols, and the
like should be tagged with <name type='nonhuman'>
</p>
</div>
<div><head>foreign </head>
<p>Marks an insertion of text not in the primary language, such as
"Talitha Cum" in Mark 5:41. The specific language should be indicated
viathe xml:lang attribute.
</p>
</div>
<div><head>hi </head>
<p>Provides simple text highlighting capability; types can be
distinguished by the
</p>
</div>
<div><head>inscription </head>
<p>inscriptions should not also be tagged as quotations. For example,
where Paul refers to an alter inscription in Athens: </p>
<eg>
<inscription>To an unknown god</inscription>
</eg>
</div>
<div><head>mentioned </head>
<p>
</p>
</div>
<div><head>name </head>
<p>
</p>
</div>
<div><head>q </head>
<p>
</p>
</div>
<div><head>rdg </head>
<p>
</p>
</div>
<div><head>seg </head>
<p>
</p>
</div>
<div><head>transChange </head>
<p>
</p>
</div>
<div><head>w </head>
<p>
</p>
</div>
</div>
<!--
=======================================================================
-->
<div><head>Canonical refererence (or versification) schemes
</head>
<p>
A canonical refererence scheme is a system of agreed names and/or
numbers for for referring to parts of a document. In the Bible, the
traditional system used in most languages consists of a book name
(such as Genesis), then a chapter number, then a verse number. Most
works of Classical literature have similar schemes, nearly all of
which are also hierarchical (that is, they work from larger units to
smaller).
</p>
<p>
The basic form for Biblical verse references is strictly defined by
OSIS, so that various electronic Bible versions can interoperate
easily. Standard abbreviations for the canonical and deuterocanonical
books are provided; chapter and verse numbers follow the book
abbreviation separated by periods. For example:
</p>
<eg>
Matt.1.1
</eg>
<p>
OSIS uses such identifiers in several places:
</p>
<ul>
<li>To identify a portion of text from an actual canonical
work, such as a verse of the Bible. The verse element bears an osisID
attribute which must include the identifier appropriate to the verse.
For example, <v osisID="Matt.1.1">>....</li>
<li>To identify a reference <i>to</i> a Biblical
or other passage, that is not contained at the point of reference.
For example, <p>The correctness of my exegesis is
incontrovertibly proven by <reference osisRef="Matt.1.1">the
first verse of Matthew.</p></li>
<li>In the header, to identify what portions of the Bible are
included in a declared work. For example, a particular edition may
include only the NT and Psalms. The scope element may be used to
specify each relevant portion.</li>
</ul>
<div><head>Partial identifiers
</head>
<p>
It is permissible to refer to an entire chapter by simply omitting
the verse number and the preceding ".", for example:
</p>
<eg>
Matt.5
</eg>
<p>
Similarly, it is permissible to refer to an entire book by omitting
the chapter and verse number and both corresponding periods:
</p>
<eg>
1Cor
</eg>
<p>
For those books of the Bible that have only 1 chapter, the chapter
number "1" must be specified: The first verse of Jude is thus
Jude.1.1, not Jude.1.
</p>
</div>
<div><head>Works</head>
<p>
A reference can also identify a place in a particular edition or
translation of the Bible, or to other works entirely, such as
Josephus, writing of the Apostolic fathers, classical or modern
literature, and so on. We discuss later how to declare particular
works and give them local short names. Once that is done, the short
name for any declared work can be put before any reference to it, for
example:
</p>
<eg>
NIV:Matt.1.1
</eg>
<p>
The colon is required, to make it is clear where the work ends and
the within-work reference begins. Most commonly, however, the work is
omitted (the default work used then is whatever work was named on the
osisWorkID attribute of the osisText element).
</p>
<p>
It is possible to refer to an entire work, such as the whole CEV,
NIV, KJV, the Iliad, etc. However, to do so the work name must be
stated, and the following colon must be included (without the colon,
it would be interpreted as a top-level identifier within the work).
</p>
</div>
<div><head>Sub-identifiers
</head>
<p>
Translations also often split verses into parts, provided labels such
as "a" and "b" for the separate parts. Encoders may freely add
sub-identifiers below the lowest standardized level. They are set off
from the standardized portion by the character "!" (as opposed to "."
between levels of the standard system). For example:
</p>
<eg>
Rev.2.20!b
</eg>
<p>
Such subdivisions are not standard across different translations, so
applications must be prepared to discard them when trying to locate a
referenced location in a different edition.
</p>
<p>
These extensions are not considered a formal part of the canonical
reference scheme, and so a work that uses them need not claim it is
using a different scheme.
</p>
</div>
<div><head>Grouping
</head>
<p>
Translators often group several adjacent verses into a single block,
so that they can translate them using word order more natural in the
target language. In such cases, the larger unit (commonly a paragraph
or p element), gets an osisID that lists all the individual osisIDs
for the verses included, separated by white space. For example:
</p>
<eg>
<p osisID="Matt.1.1 Matt.1.2 Matt.1.3">...</p>
</eg>
<p>
osisIDs never allow the use of ranges. Only osisRefs (discussed later) do.
</p>
</div>
<div><head>Other details of osisIDs</head>
<p>
The "."-separated parts of an osisID are defined to represent a
hierarchy. In the traditional versification (introded by Whittingham
about ????), these would be book, chapter, and verse numbers. In
other schemes for the Bible, or schemes for entirely different works,
the names of the parts may differ, but the expectation is that they
still form a hierarchy.
</p>
<p>
The parts of an osisID may contain any mixture of numbers, letters,
hyphens, and underscore. However, to avoid conflict with the other
punctuations used (such as ":" to separate the work from the in-work
location, "@" to separate fine-grained references in osisRefs, and
"!" to separate work-specifiec extensions to a versification scheme),
no other characters are allowed.
</p>
<p>
As with XML in general, these identifiers are case-sensitive: "Matt"
is the correct form, and there is no Bible book in OSIS that is
called "matt" or "MATT". Applications for end users may choose to
accept case variants in such names, but applications for encoders
(such as OSIS editors) must not produce documents with invalid
reference names.
</p>
</div>
<div><head>Coding multiple versification or reference schemes in a
single document</head>
<p>
"!" as the terminator (after which encoders may append names and/or
numbers to provide finer-grained reference points).
</p>
<p>
A work may provide identifiers drawn from multiple distinct
versification schemes. A Bible may wish to provide both the Hebrew
and Greek traditional verse numberings; while a work of classical
literature may be made more accessible by marking the boundaries of
canonical units drawn from completely unrelated systems, such as Loeb
and Whiston for Josephus (and 4 more systems for Josephus' Jewish War
specifically -- see H. Douglas Buckwalter and Mary K. Shoaff, Guide
to Reference Systems for the Works of Flavious Josephus, Evangelical
Theological Society, 1995, ISBN 093205501X).
</p>
<p>
A simpler case may also arise where multiple reference schemes are in
use: an osis Corpus that includes several osisTexts, each of which
uses a different reference scheme. This case is simpler, since each
osisText can provide its own default reference system, using the
osisRefWork attribute on osisText.
</p>
<p>
This is accomplished in the same way as just described for discursive
translations: the multiple identifiers are simply placed where
needed, separated by spaces when they co-occur on a single element.
Each reference system used much be declared as a work in the header,
and each identifier much indicate the reference system from which it
is drawn. For example, a line of Josephus that has two distinct
identifiers would appear like this (presuming the appropriate work
declarations in the header):
</p>
<eg>
<l osisID="josephus-war:loeb:245.22 josephus-war:whiston:22.3.14b">
</eg>
<p>
Because verse, chapter, and similar elements can be expressed by
empty-element pairs when necessary, it is possible to encode multiple
reference systems even though they may have completely unrelated
start and end points for their units. For example, a work that has
one reference system based on sentences, and another based on lines
of a normative print edition, can co-exist. However, taken to
extremes this would get rather messy, and be difficult to maintain
without OSIS-aware software to assist.
</p>
</div>
</div>
<!-- ==================================================================== -->
<div><head>OSIS references</head>
<p>
An OSIS reference is very much like an osisID. The fundamental
difference is that while an osisID <hi>identifies</hi> the actual
occurrence of canonical text, an osisRef is used to <hi>refer</hi> to
canonical text from somewhere else. For example, a footnote
(particularly one of type="crossReference") may refer to a related
passage, or a section heading in the Mark may include references to
the parallel passages in Matthew and Luke; in such cases an osisRef
rather than an osisID is used.
</p>
<p>
Any valid osisID is also a valid osisRef, and refers to the same
thing. Thus for example, a commentary might say:
</p>
<eg>
<p>The same interpretive method applies also in <reference
osisRef="Luke.1.1">the first verse of Luke</reference>.</p>
</eg>
<p>
However, osisRefs provide additional capabilities. They can refer to
a contiguous range of books, chapters, verses (or other units, as
applicable to the work being referenced), and they can refer to
precise locations within a given canonically-reference unit.
</p>
<p>
To refer to a range, simply include two osisIDs, one for the first
verse (or chapter or book) of the range, and one for the last.
Separate the 2 values by a single hyphen (white space is also
permitted, but not recommended, on either or both sides of the
hyphen). For example:
</p>
<eg>
John.3.14-John.3.16
Prov.30-Prov.31
Esth-Song
Ps.149-Prov.3.4
</eg>
<p>
Both sides of the hyphen must hold complete references. It is not
correct to abbreviate the first example above to merely
"John.3.14-16" (as always, the values of osisID and osisRef
attributes need not be the same values displayed to the reader).
</p>
<p>
A single osisRef cannot identify a discontiguous range of a work. For
example, a complex reference such as "John 3:14-16, 18; 4:1-2; 19-20"
cannot be encoded as a single reference. It must instead be encoded
as several parts, each contiguous:
</p>
<eg>
<p>See also
<reference osisRef="John.3.14-John.3.6">John 3:14-16,
</reference>
<reference osisRef="John.3.18">18; </reference>
<reference osisRef="John.4.1-John.4.2">4:1-2; </reference>
<reference osisRef="John.19-John.20">4:1-2;
</reference>.</p>
</eg>
<p>It is permissible for osisRefs, including those on either side of
a hyphen in a range reference, to use osisIDs that include the
work-specific extension fields ("!" followed by a name).</p>
To refer to specific locations within a named canonical reference
element, give the osisID as usual, followed by a "grain identifier",
which consists of the character "@", and then an identifier for the
portion desired. Such identifiers are of the form:
<eg>
grainType(parameters)
</eg>
<p>
Two grain types are defined at this time:
</p>
<p>
cp (short for "code point") counts through the character content of
the referenced element, essentially by characters. Technically, the
units counted are Unicode code points, a term which is defined more
precisely than the generic term "character". The first code point of
content is number 1, not 0.
</p>
<p>
No markup included within the element specifies is counted, and
markup does not imply a space for purposes of counting even if it may
for purposes of layout or printing.
</p>
<p>
When referring to a location in canonical content, text within
non-canonical elements is not counted. Thus, the intuitive count will
not be changed by the insertion of notes, references, critical
apparatus, and the like). When referring to a location in
non-canonical content, all text in all included elements counts,
whether canonical or not.
</p>
<p>
Grains: s finds the first match of the string value specified, with
regard to case, within the canonical reference specified. If the
canonical reference is one of several applied to the same target
element (for example, when a paragraph has osisRef="Matt.1.1 Matt.1.2
Matt.1.3), that whole element is searched. If the string is not
found, the user agent must warn the user, and may offer to suggest a
best guess (for example, by searching again while ignoring case,
whitespace, punctuation, accents, spelling variation, etc).
</p>
</div>
<!-- ==================================================================== -->
<div><head>Different versification systems
</head>
<p>
Hebrew tradition numbers the proscriptions above Psalms (such as "A
Maskil according to David") as verse one, and goes on from there;
Greek tradition does not number the proscriptions, and start verse 1
after it. Of course, this would make all references in Psalms be off
by one verse if the version reached is from the other tradition.
</p>
<p>
A few languages use traditional reference schemes that completely
differ from the familiar book/chapter/verse one.
</p>
<p>
Many works of Classical literature likewise have more than one
standard canonical reference scheme, such a Loeb numbers plus another
method.
</p>
<p>
In such cases, where there are large and systematic differences,
different "versification schemes" must be defined and named. On the
other hand, nearly every edition of the Bible has some slight
deviations from a standard versification scheme that it otherwise
follows: for example, subdividing verses into parts "a" and "b",
combining verses into a larger translation unit, and so on. It is
highly undesirable to call these separate versification schemes,
because they differ so slightly; because the differences can be
mechanically resolved; and because there is considerably overhead to
maintaining and mapping among versification schemes. Thus, as
described below such minor extensions can be done without an edition
having to say it is using a completely different versification scheme.
</p>
<p>
BTG intends to develop an XML schema for declaration files that can
express such systems, and their mapping to other systems. This work
has not been completed. However, we reserve the following names for
versification schemes we already know to be relevant:
</p>
<eg>
Hebrew
NA27
SamPent
LXX
</eg>
<p>
Each work must identify which versification scheme(s) it uses; this
is done on the work's entry in the header.
</p>
<p>
References can also state what versification scheme they are
expressed in, so that they may be correctly interpreted.
</p>
<p>
HTML may provide targets that look like canonical Bible references,
but this would not remove the requirement to specify osisID where
applicable. osisID is mandatory when applicable.
</p>
</div>
<!-- ==================================================================== -->
<div><head>Conformance requirements</head>
<div><head>Conformance levels</head>
<p>
There are 4 levels of OSIS conformance for the markup in OSIS documents:
</p>
<div><head>Level 1: "Minimal OSIS document"</head>
<p>
The document must be a well-formed and valid XML document
according to the OSIS schema.
</p>
<p>
The document must be complete in accordance with the scope
declaration in its work declaration. For example, a document with a
missing chapter is not OSIS-conforming.
</p>
<p>
The document must mark all canonical references where applicable
(for example, book, chapter, and verse boundaries in Bibles. Marking
in groups,
for example a paragraph that includes several verses, is permissible.
</p>
<p>
The header must include work declarations for the document itself,
and for the versification system it uses
</p>
<p>
All work declarations must provide unique osisWorkID values, and
<hi>only</hi> those values may appear as work identifiers in osisIDs
and osisRefs (whether by default or explicit) in the document.
</p>
<p>
All work declarations must provide at least title, creator, and
date(s). Creator may be coded as "(anonymous)" or "(unknown)" if
applicable. The date of electronic publication is required, but other
dates may be coded as "(unknown)" if applicable).
</p>
<p>
At least one revision declaration element must be included,
describing the most recent substantial changes to the document. The
name and email address
</p>
<p>
All elements must be used substantially in accordance with their
intended meaning as conveyed in this documentation (including
documentation referred to, such as Dublin Core, USMARC Relator Codes,
and so on.
</p>
</div>
<div><head>Level 2: "Basic OSIS Document"</head>
<p>
All requirements of Level 1 conformance must be fulfilled.
</p>
<p>
A clear statement of rights must be provided within the rights
element. If the document is licensed for free copying under certain
conditions, those conditions or a reliable URI to them must be
provided. If there are encumbrances or if clearance is required to
copy or use the work, contact information for the responsible party
must be provide directly within the rights element.
</p>
<p>
The source edition from which the electronic edition was produced,
must be clearly identified, or clearly stated as unknown (the latter
practice is deprecated, and encoders are strongly encouraged to make
a serious effort to identify the source edition).
</p>
<p>
All inscriptions (for example, "mene mene tekel parsin") must be
marked where applicable.
</p>
<p>
All instances, translations, or transliterations of the
tetragrammaton must be marked via the divineName element.
</p>
<p>
All languages substantially appearing in the text must be
identified, and all
points where the text itself identifies a phrase as coming from a
particular language must be marked up to match (for example, "Talitha
cumi").
</p>
<p>
All epistolary markup (opener, closer, signature, salute) must be
provided where applicable.
</p>
<p>
Poetic text must be marked sufficiently to enable rendering it
readably as poetry. The distinction of using l for linguistically or
poetically significant line breaks, versus using lb for
typographically significant or preferred line breaks, must be
maintained.
</p>
<p>
If the source edition had section, paragraph, block quotation, or
other similar markup in addition to book, chapter, and verse
numbering, that markup must be included.
</p>
<p>
If the source edition had footnotes, sidenotes, endnotes, or other
notes, they must be included, and must be distinguished into as many
types as can be readily distinguished by observing the typographic
conventions of the source edition.
</p>
</div>
<div><head>Level 3: Complete OSIS document</head>
<p>
All the requirements of Level 2 must be fulfilled.
</p>
<p>
All notes, front and back matter, illustrations, section heads, and
other non-canonical phenomena of the source edition must be included.
</p>
</div>
<div><head>Level 4: Scholarly OSIS document</head>
<p>
All the requirements of Level 3 must be fulfilled.
</p>
<p>
Substantial critical apparatus must be available in the text, such
as: Strong's or comparable numbering of words; part-of-speech and/or
other linguistic markup; encoding of variant readings, critical
apparatus, and the like; extensive translation, scholarly,
interpretive, or other notes.
</p>
<p>
At least highly significant persons and places in the text must be
marked as names, as refer to the normative form of the corresponding
individual (the BIble Technologies Group is preparing normative lists
at this time). Where such identification is a matter of non-obvious
interpretation, that fact must be marked, and the encoders' practices
and biases should be duly noted in the front matter.
</p>
<p>
The text must also conform to the requirements of Level 3 Quality
as described below.
</p>
</div>
</div>
<div><head>Quality levels</head>
<p>
These conformance levels do not specify the level of accuracy and
proofreading of the text proper. This is instead measured by the
following scale of "Quality":
</p>
</div>
<div><head>Level 1: Sub-OCR Quality</head>
<p>
The text may have many typographical errors; essentially, it is
unproofread text from automated OCR, probably of a less-than-ideal
original.
</p>
</div>
<div><head>Level 2: OCR Quality</head>
<p>
The text may have up to 5 typographical errors per source page. It
may be unproofead output from ideal OCR of an ideal source, or may
have been run at least through rudimentary spell-checking or
vocabulary counting and repair, or perhaps entered by a double-keying
or similar service that maintains accuracy to the required level.
</p>
</div>
<div><head>Level 3: Proof Quality</head>
<p>
There may not be more than an average of 1 error per source page (or
per 2000 characters of content) as compared with the stated copy
text. This requirement does not preclude producing new editions,
which for example may fix typos in the original, normalize spelling
of older texts, and so on. Howeve, in such cases it is recommended
that the best available copy of the source text as it existed prior
to such modernizations, also be made available.
</p>
</div>
<div><head>Level 4: Trusted Quality</head>
<p>
A Trusted Quality document must fulfill all the requirements of a
Proof Quality document, and must also have been in use for at least
one year, and read by at least 5 independent proofreaders, with all
noted errors fixed. The text should have available a complete and
log of changes made since it reached Proof Quality. Random
spot-checks of at least 3% of the text must come up with no instances
of more than 1 error per 5 pages (or 10,000 characters of content).
</p>
</div>
</div>
<!-- ==================================================================== -->
<div><head>Application Requirements</head>
<p>
Applications should avoid making any processing distinctions between
elements represented as non-crossing single elements or as milestone
pairs.
</p>
<p>Applications must interpret OSIS references as accurately as is
feasible, but apply smart fallback as needed. For example, grains
will not map across translations or languages, though most will
typically survive changes between successive editions of the same
text, or differences between British and American English versions.
Applications should in general at least offer to take the user to the
nearest reliably-findable place; in this case, the verse. </p>
<p>
OSIS-conformant applications must be able to interpret the OSIS
elements and process them in a manner consistent with their express
intent as specified in this document, and in accordance with standard
practices of Bible publishing. For example, applications should be
capable of distinguishing the typography used for inscriptions, the
divineName, verse labels and references, foreign insertions in the
text, notes, and so on in ways readily recognizable to users of print
Bibles.
</p>
<p>
The Bible Technologies group also strongly advocates making all
OSIS-aware software accessible to print-disabled users. This includes
details such as providing text alternates for all graphics,
</p>
</div>
<!-- ==================================================================== -->
<div><head>Alphabetical list of Elements</head>
<list type='definition'>
<label>NAME</label><item>PLACEMENT</item>
<label>a</label><item>Content, inline</item>
<label>abbr</label><item>Content, inline</item>
<label>actor</label><item>castGroup structure</item>
<label>caption</label><item>Figure structure</item>
<label>castGroup</label><item>castGroup structure</item>
<label>castItem</label><item>castGroup structure</item>
<label>castList</label><item>castGroup structure</item>
<label>catchWord</label><item>Annotation</item>
<label>cell</label><item>table structure</item>
<label>chapter</label><item>Main content</item>
<label>closer</label><item>Epistolary</item>
<label>contributor</label><item>Dublin Core (in work)</item>
<label>coverage</label><item>Dublin Core (in work)</item>
<label>creator</label><item>Dublin Core (in work)</item>
<label>date</label><item>Dublin Core (in work)</item>
<label>description</label><item>Dublin Core (in work)</item>
<label>div</label><item></item>
<label>divineName</label><item></item>
<label>figure</label><item>Figure structure</item>
<label>foreign</label><item>Main content</item>
<label>format</label><item>Dublin Core (in work)</item>
<label>head</label><item>Main content</item>
<label>header</label><item>Header</item>
<label>hi</label><item>Main content</item>
<label>identifier</label><item>Dublin Core (in work)</item>
<label>index</label><item>Main content</item>
<label>inscription</label><item>Main content</item>
<label>item</label><item>List structure</item>
<label>l</label><item>Poetic structure</item>
<label>label</label><item>List structure</item>
<label>language</label><item>Dublin Core (in work)</item>
<label>lb</label><item>Poetic structure</item>
<label>lg</label><item>Poetic structure</item>
<label>list</label><item>List structure</item>
<label>mentioned</label><item>Annotation</item>
<label>milestone</label><item>Annotation</item>
<label>milestoneEnd</label><item>(deprecated -- do not use)</item>
<label>milestoneStart</label><item>(deprecated -- do not use)</item>
<label>name</label><item>Main content</item>
<label>note</label><item>Annotation</item>
<label>osis</label><item>Header</item>
<label>osisCorpus</label><item>Header</item>
<label>osisText</label><item>Header</item>
<label>p</label><item>Main content</item>
<label>publisher</label><item>Dublin Core (in work)</item>
<label>q</label><item>Main content</item>
<label>rdg</label><item>Annotation</item>
<label>reference</label><item>Reference system</item>
<label>refSystem</label><item></item>
<label>relation</label><item>Dublin Core (in work)</item>
<label>revisionDesc</label><item>Header</item>
<label>rights</label><item>Dublin Core (in work)</item>
<label>role</label><item>castGroup structure</item>
<label>roleDesc</label><item>castGroup structure</item>
<label>row</label><item>table structure</item>
<label>salute</label><item>Epistolary</item>
<label>scope</label><item>Dublin Core (in work)</item>
<label>seg</label><item>Main content</item>
<label>signed</label><item>Epistolary</item>
<label>source</label><item>Dublin Core (in work)</item>
<label>speaker</label><item></item>
<label>speech</label><item></item>
<label>subject</label><item>Dublin Core (in work)</item>
<label>table</label><item>table structure</item>
<label>teiHeader</label><item>Header</item>
<label>title</label><item>Dublin Core (in work)</item>
<label>transChange</label><item>Annotation</item>
<label>type</label><item>Dublin Core (in work)</item>
<label>verse</label><item>Reference system</item>
<label>w</label><item>Annotation</item>
<label>work</label><item>Header</item>
</list>
</div>
<div><head>Alphabetical list of Attributes and normative values</head>
<div><head>Global attributes</head>
<p>
These global attributes are in addition to xml:base, xml:lang, and
xml:space which are defined by the XML standard itself.
</p>
<table>
<row>
<cell>Attribute name</cell>
<cell>DataType</cell>
<cell>Usage</cell>
<cell>Description</cell>
</row>
<row>
<cell>annotateWork</cell>
<cell>xs:string</cell>
<cell>optional</cell>
<cell></cell>
</row>
<row>
<cell>annotateType</cell>
<cell>osisAnnotation</cell>
<cell>optional</cell>
<cell></cell>
</row>
<row>
<cell>ID</cell>
<cell>xs:ID</cell>
<cell>optional</cell>
<cell>May be added to any element, generally to make that
element accessible as a link target for generic hypertext browsers,
or for the OSIS a element.</cell>
</row>
<row>
<cell>osisID</cell>
<cell>osisIDType</cell>
<cell>optional</cell>
<cell>The osisID attribute identifies the element bearing it
as a container for actual canonically-referenceable text, and provides
the applicable osisID: osisID="Matt.1.1". It must not be used on
elements that merely refer to, or discuss, a
canonically-referenceable text. For those cases, use the annoteWork
and osisRef attributes, instead. See the section on reference systems
for details on the form required for this attribute's value.</cell>
</row>
<row>
<cell>canonical</cell>
<cell>true | false</cell>
<cell>optional</cell>
<cell>The canonical attribute identifies the element bearing
it as containing actual text of the work being encoded, as opposed to
annotations, commentary, inserted headings, header metadata, notes,
and other (non-canonical) information. Its value inherits in the same
way as xml:lang. That is, the value applies to all descendant
elements except where overridden.</cell>
</row>
<row>
<cell>resp</cell>
<cell>xs:string</cell>
<cell>optional</cell>
<cell>This attribute, whose name is short for "responsible
party", may be coded on any element to identify the party primarily
responsible for that element and its content. For example, it might
identify a member of a translation team; or on a note, it might
identify the author of the note. Each distinct responsible party must
be identified by the same value of this attribute wherever they are
identified at all (that is, it is not permitted to use their initials
sometimes, their last names other times, etc.). A list of responsible
parties should be provided in the front matter or in the
header.</cell>
</row>
<row>
<cell>type</cell>
<cell>xs:string (several element types restrict the values,
as listed below).</cell>
<cell>optional</cell>
<cell>The type attribute allows encoders to identify more
precise distinctions within the borad applicability of any given
element. For example, the div (division) element has many subtypes,
such as bookGroup, concordance, dedication, glossary, etc. Many other
element types also have pre-defined values provided for the type
attribute. Some but not all of those element types also permit users
to add their own values, so long as they begin with "x-". When a
predefined type is applicable, it must be used instead of creating a
new type. </cell>
</row>
<row>
<cell>subType</cell>
<cell>xs:string</cell>
<cell>optional</cell>
<cell>In the rare event that the type attribute does not
provide a fine-enough grained distinction of element types, the
sub-type attribute may be used to make such distinctions. There are
generally no restrictions on the values permitted for subType, except
that the encoder should be consistent, and should document the
meaning of any values used.</cell>
</row>
<row>
<cell>n</cell>
<cell>xs:string</cell>
<cell>optional</cell>
<cell>This attribute is identical to the TEI n attribute, and
may be used to provide a name or number ot identify the particular
element instance. However, it should not be used to encode a value
that for which the osisID, osisRef, or ____ attribute is
applicable.</cell>
</row>
<row>
<cell>xml:lang</cell>
<cell>xs:language</cell>
<cell>optional</cell>
<cell>This attribute is defined by the xml standard itself,
and identifies the primary natural language of the content of an
element. The value of this attribute is inherited; that is, any
contained elements are presumed to be in the same language, unless
they override it by specifying their own explicit xml:lang attribute
value. The form of the xml:lang attribute is constrained by Internet
specificatins, particularly ___. However, many languages lack
identifier codes in that system. In such cases, use instead the SIL
Ethnologue codes, available from ____. For more details on language
code see ____. </cell>
</row>
<row>
<cell>script</cell>
<cell>osisScripts</cell>
<cell>optional</cell>
<cell>This attribute provides a slight extension beyond the
capabilities of the xml:lang attribute. For many languages, it is
enough to specify the language itself, and the country where it is
spoken (say, Canadian vs. French dialects of the French language).
However, there are cases where a given language community may use
multiple writing systems: either different character sets and
character usage rules; different spelling or other conventions; etc.
In such cases, the particular script system used for writing the
current work (or element within a work) must be specified via this
attribute. This attribute inherits in precisely the same manner as
xml:lang.</cell>
</row>
</table>
</div><!-- global attributes -->
<div><head>Normative values for the type attribute, by element</head>
<p>
The heading for each basic element type below, indicates whether the
list of values provided is extensible (by adding names beginning with
"x-", or non-extensible).
</p>
<p>
Users who find values potentially of general use, that are not
already provided, are asked to send them to the editors for possible
incorporation into future versions of the specification. Likewise,
users who discover any substantial ambiguity in the values provided,
are asked to notify us and to provide examples and explanations, so
that we can attempt to rectify any such problem.
</p>
<div><head>annotation</head>
<list>
<label>commentary</label><item></item>
<label>exposition</label><item></item>
<label>meditation</label><item></item>
<label>outline</label><item></item>
<label>poeticRendering</label><item></item>
<label>rebuttal</label><item></item>
<label>sermon</label><item></item>
<label>studyGuide</label><item></item>
<label>translation</label><item></item>
</list>
</div>
<div><head>calendar</head>
<list>
<label>Chinese</label><item></item>
<label>Gregorian</label><item></item>
<label>Islamic</label><item></item>
<label>ISO</label><item></item>
<label>Jewish</label><item></item>
<label>Julian</label><item></item>
</list>
</div>
<div><head>milestoneStart and milestoneEnd (deprecated)</head>
<p>
In OSIS 1.1, only one pair of element types was provided for marking
up elements that cross others: milestoneStart and milestoneEnd. Each
would set its type attribute to the name of the element it was
standing in for. The types listed below were the only types permitted
to be expressed via milestone pairs. This method, and thuis this
list, is now obsolete.
</p>
<list>
<label>abbr</label><item></item>
<label>chapter</label><item></item>
<label>closer</label><item></item>
<label>div</label><item></item>
<label>foreign</label><item></item>
<label>l</label><item></item>
<label>lg</label><item></item>
<label>q</label><item></item>
<label>salute</label><item></item>
<label>seg</label><item></item>
<label>signed</label><item></item>
<label>speech</label><item></item>
<label>verse</label><item></item>
</list>
</div>
<div><head>change types</head>
<list>
<label>added</label><item></item>
<label>amplified</label><item></item>
<label>changed</label><item></item>
<label>deleted</label><item></item>
<label>moved</label><item></item>
<label>tenseChange</label><item></item>
</list>
</div>
<div><head>div</head>
<p>
The type attribute for div mainly identifies larger sections that
occur in print volumes, especially Bibles. This list was determined
in part by examining a large selection of print Bibles, and covers
most things that seem to be common. However, the list may be extended
if necessary by adding names beginning "x-".
</p>
<list>
<label>acknowledgement</label><item></item>
<label>afterword</label><item></item>
<label>appendix</label><item></item>
<label>back</label><item></item>
<label>body</label><item></item>
<label>book</label><item></item>
<label>bookGroup</label><item></item>
<label>colophon</label><item></item>
<label>commentary</label><item></item>
<label>concordance</label><item></item>
<label>coverPage</label><item></item>
<label>dedication</label><item></item>
<label>devotional</label><item></item>
<label>entry</label><item></item>
<label>front</label><item></item>
<label>gazetter</label><item></item>
<label>glossary</label><item></item>
<label>imprimatur</label><item></item>
<label>index</label><item></item>
<label>introduction</label><item></item>
<label>majorSection</label><item></item>
<label>map</label><item></item>
<label>outline</label><item></item>
<label>preface</label><item></item>
<label>section</label><item></item>
<label>subSection</label><item></item>
<label>titlePage</label><item></item>
</list>
</div>
<div><head>osisMilestonePt </head>
<list>
<label>column</label><item></item>
<label>footer</label><item></item>
<label>halfLine</label><item></item>
<label>header</label><item></item>
<label>line</label><item></item>
<label>pb</label><item></item>
<label>screen</label><item></item>
</list>
</div>
<div><head>name</head>
<list>
<label>geographic</label><item></item>
<label>holiday</label><item></item>
<label>nonhuman</label><item></item>
<label>person</label><item></item>
<label>ritual</label><item></item>
</list>
</div>
<div><head>notes</head>
<list>
<label>allusion</label><item></item>
<label>alternative</label><item></item>
<label>background</label><item></item>
<label>citation</label><item></item>
<label>crossReference</label><item></item>
<label>devotional</label><item></item>
<label>exegesis</label><item></item>
<label>explanation</label><item></item>
<label>study</label><item></item>
<label>translation</label><item></item>
<label>variant</label><item></item>
</list>
</div>
<div><head>contributor roles (base set, not complete)</head>
<list>
<label>adp</label><item></item>
<label>ann</label><item></item>
<label>art</label><item></item>
<label>aut</label><item></item>
<label>aqt</label><item></item>
<label>aft</label><item></item>
<label>aui</label><item></item>
<label>bnd</label><item></item>
<label>bdd</label><item></item>
<label>bkd</label><item></item>
<label>bkp</label><item></item>
<label>bjd</label><item></item>
<label>bpd</label><item></item>
<label>ctg</label><item></item>
<label>clb</label><item></item>
<label>cmm</label><item></item>
<label>cwt</label><item></item>
<label>com</label><item></item>
<label>ctb</label><item></item>
<label>cre</label><item></item>
<label>edt</label><item></item>
<label>ilu</label><item></item>
<label>ill</label><item></item>
<label>pbl</label><item></item>
<label>trl</label><item></item>
</list>
</div>
<div><head>titles</head>
<list>
<label>acrostic</label><item></item>
<label>continued</label><item></item>
<label>main</label><item></item>
<label>parallel</label><item></item>
<label>psalm</label><item></item>
<label>sub</label><item></item>
</list>
</div>
<!-- ==================================================================== -->
<div><head>Normative Abbreviations for canonical and
deutero-canonical books</head>
<p>
These names are taken from the SBL Manual of Style, which also
provides normative abbreviations for works of classical literature,
manuscripts, journals, and other information objects of interest to
Biblical studies.
</p>
<div>
<p>Hebrew Bible/Old Testament</p>
<list type="definition">
<label>Gen</label> <item>Genesis</item>
<label>Exod</label> <item>Exodus</item>
<label>Lev</label> <item>Leviticus</item>
<label>Num</label> <item>Numbers</item>
<label>Deut</label> <item>Deuteronomy</item>
<label>Josh</label> <item>Joshua</item>
<label>Judg</label> <item>Judges</item>
<label>Ruth</label> <item>Ruth</item>
<label>1Sam</label> <item>1 Samuel</item>
<label>2Sam</label> <item>2 Samuel</item>
<label>1Kgs</label> <item>1 Kings</item>
<label>2Kgs</label> <item>2 Kings</item>
<label>1Chr</label> <item>1 Chronicles</item>
<label>2Chr</label> <item>2 Chronicles</item>
<label>Ezra</label> <item>Ezra</item>
<label>Neh</label> <item>Nehemiah</item>
<label>Esth</label> <item>Esther</item>
<label>Job</label> <item>Job</item>
<label>Ps</label> <item>Psalms</item>
<label>Prov</label> <item>Proverbs</item>
<label>Eccl</label> <item>Ecclesiastes</item>
<label>Song</label> <item>Song of Solomon</item>
<label>Isa</label> <item>Isaiah</item>
<label>Jer</label> <item>Jeremiah</item>
<label>Lam</label> <item>Lamentations</item>
<label>Ezek</label> <item>Ezekiel</item>
<label>Dan</label> <item>Daniel</item>
<label>Hos</label> <item>Hosea</item>
<label>Joel</label> <item>Joel</item>
<label>Amos</label> <item>Amos</item>
<label>Obad</label> <item>Obadiah</item>
<label>Jonah</label> <item>Jonah</item>
<label>Mic</label> <item>Micah </item>
<label>Nah</label> <item>Nahum</item>
<label>Hab</label> <item>Habakkuk</item>
<label>Zeph</label> <item>Zephaniah</item>
<label>Hag</label> <item>Haggai</item>
<label>Zech</label> <item>Zechariah</item>
<label>Mal</label> <item>Malachi</item>
</list>
<p>New Testament</p>
<list type="definition">
<label>Matt</label> <item>Matthew</item>
<label>Mark</label> <item>Mark</item>
<label>Luke</label> <item>Luke</item>
<label>John</label> <item>John</item>
<label>Acts</label> <item>Acts</item>
<label>Rom</label> <item>Romans</item>
<label>1Cor</label> <item>1 Corinthians</item>
<label>2Cor</label> <item>2 Corinthians</item>
<label>Gal</label> <item>Galatians</item>
<label>Eph</label> <item>Ephesians</item>
<label>Phil</label> <item>Philippians</item>
<label>Col</label> <item>Colossians</item>
<label>1Thess</label> <item>1 Thessalonians</item>
<label>2Thess</label> <item>2 Thessalonians</item>
<label>1Tim</label> <item>1 Timothy</item>
<label>2Tim</label> <item>2 Timothy</item>
<label>Titus</label> <item>Titus</item>
<label>Phlm</label> <item>Philemon</item>
<label>Heb</label> <item>Hebrews</item>
<label>Jas</label> <item>James</item>
<label>1Pet</label> <item>1 Peter</item>
<label>2Pet</label> <item>2 Peter</item>
<label>1John</label> <item>1 John</item>
<label>2John</label> <item>2 John</item>
<label>3John</label> <item>3 John</item>
<label>Jude</label> <item>Jude</item>
<label>Rev</label> <item>Revelation</item>
</list>
<p>Apocrypha and Septuagint</p>
<list type="definition">
<label>Bar</label> <item>Baruch</item>
<label>AddDan</label> <item>Additions to Daniel</item>
<label>PrAzar</label> <item>Prayer of Azariah</item>
<label>Bel</label> <item>Bel and the Dragon</item>
<label>SgThree</label> <item>Song of the Three Young Men</item>
<label>Sus</label> <item>Susanna</item>
<label>1Esd</label> <item>1 Esdras</item>
<label>2Esd</label> <item>2 Esdras</item>
<label>AddEsth</label> <item>Additions to Esther</item>
<label>EpJer</label> <item>Epistle of Jeremiah</item>
<label>Jdt</label> <item>Judith</item>
<label>1Macc</label> <item>1 Maccabees</item>
<label>2Macc</label> <item>2 Maccabees</item>
<label>3Macc</label> <item>3 Maccabees</item>
<label>4Macc</label> <item>4 Maccabees</item>
<label>PrMan</label> <item>Prayer of Manasseh</item>
<label>Sir</label> <item>Sirach/Ecclesiasticus</item>
<label>Tob</label> <item>Tobit</item>
<label>Wis</label> <item>Wisdom of Solomon</item>
</list>
<p>These abbreviations are as defined in the <i>SBL Handbook of
Style</i> published by the Society of Biblical Literature, except
that spaces have been removed from the abbreviations for some
Apocryphal and Septuagint books.</p>
<p>Note that because XML prohibits digits as the first character of
IDs and other XML names, these abbreviations cannot be used directly
as XML IDs, and are not of that schema datatype.</p>
</div>
</div>
<!-- ==================================================================== -->
<div><head>Encoding multilingual editions</head>
<p>(this section is still to be written)</p>
</div>
<!-- ==================================================================== -->
<div><head>Encoding commentaries</head>
<p>(this section is still to be written)</p>
</div>
<!-- ==================================================================== -->
<div><head>Encoding devotionals, lectionaries, and time-organized
documents</head>
<p>Information that is organized by time, must mark those
organizational units using the timeDiv element. This element is
distinguished because its osisID attribute must conform to the rules
for OSIS dates, rather than to the rules for canonical references.
Other than that, the encoding is fundamentally the same as for other
works. Actually quotations of canonical works should be labeled as
such using the osisID attribute and ; while discussions of canonical
passages should be marked </p>
</div>
<!-- ==================================================================== -->
<div><head>Encoding glossaries, dictionaries, and lexica</head>
<p>A set of dictionary markup elements, drawn directly from the
TEI, is currently in preparation, and is expected to be added in the
next release of OSIS, as an optional add-on module.</p>
</div>
<!-- ==================================================================== -->
<div><head>Complete list of USMARC Relator Codes</head>
<list type='definition'>
<label>Actor [act] </label><item>Use for a person who principally
exhibits acting skills in a musical or dramatic presentation or
entertainment.</item>
<label>Adapter [adp] </label><item>Use for a person who 1) reworks
a musical composition, usually for a different medium, or 2) rewrites
novels or stories for motion pictures or other audiovisual
medium.</item>
<label>Annotator [ann] </label><item>Use for a person who writes
manuscript annotations on a printed item.</item>
<label>Architect [arc]</label><item></item>
<label>Applicant [app]</label><item></item>
<label>Appraiser </label><item type='role.USE'>USE Expert</item>
<label>Arranger [arr] </label><item>Use for a person who
transcribes a musical composition, usually for a different medium
from that of the original; in an arrangement the musical substance
remains essentially unchanged.</item>
<label>Artist [art] </label><item>Use for a person (e.g., a
painter) who conceives, and perhaps also implements, an original
graphic design or work of art, if specific codes (e.g., [egr], [etr])
are not desired. For book illustrators, prefer Illustrator [ill].
(UF Graphic technician)</item>
<label>Assignee [asg] </label><item>Use for a person or
organization to whom a license for printing or publishing has been
transferred.</item>
<label>Associated name [asn] </label><item>Use as a general relator
for a name associated with or found in an item or collection, or
which cannot be determined to be that of a Former owner [fmo] or
other designated relator indicative of provenance.</item>
<label>Attributed name [att] </label><item>Use to relate an author,
artist, etc. to a work for which there is or once was substantial
authority for designating that person as author, creator, etc. of the
work. (UF Supposed name)</item>
<label>Auctioneer [auc] </label><item>Use for a person or corporate
body in change or the estimation and public auctioning of goods,
particularly books, artistic works, etc.</item>
<label>Author [aut] </label><item>Use for a person or corporate
body chiefly responsible for the intellectual or artistic content of
a work. This term may also be used when more than one person or body
bears such responsibility. (UF Joint author)</item>
<label>Author in quotations or text extracts [aqt] </label><item>Use
for a person whose work is largely quoted or extracted in a works to
which he or she di not contribute directly. Such quotations are
found particularly in exhibition catalogs, collections of
photographs, etc.</item>
<label>Author of afterword, colophon, etc. [aft] </label><item>Use
for a person or corporate body responsible for an afterword,
postface, colophon, etc. but who is not the but who is not the chief
author of a work.</item>
<label>Author of introduction, etc. [aui] </label><item>Use for a
person or corporate body responsible for an introduction, preface,
foreword, afterword, or other critical matter, but who is not the
chief author.</item>
<label>Author of screenplay, etc. [aus] </label><item>Use for a
person or corporate body responsible for a motion picture screenplay,
dialog, spoken commentary, etc.</item>
<label>Bibliographic antecedent [ant] </label><item>Use for the
author responsible for a work upon which the work represented by the
catalog record is based. This may be appropriate for adaptations,
sequels, continuations, indexes, etc.</item>
<label>Binder [bnd]</label><item></item>
<label>Binding designer [bdd] </label><item> (UF Designer of binding)</item>
<label>Book designer [bkd] </label><item>Use for the person or firm
responsible for the entire graphic design of a book, including
arrangement of type and illustration, choice of materials, and
process used. (UF Designer of book)</item>
<label>Book producer [bkp] </label><item>Use for the person or firm
responsible for the production of books and other print media, if
specific codes (e.g., [bkd], [egr], [tyd], [prt]) are not desired.
(UF Producer of book)</item>
<label>Bookjacket designer [bjd] </label><item> (UF Designer of
bookjacket)</item>
<label>Bookplate designer [bpd] </label><item> (UF Designer of
bookplate)</item>
<label>Bookseller [bsl]</label><item></item>
<label>Bowdlerizer </label><item type='role.USE'>USE Censor</item>
<label>Calligrapher [cll]</label><item></item>
<label>Cartographer [ctg]</label><item></item>
<label>Censor [cns] </label><item>Use for a censor, bowdlerizer,
expurgator, etc., official or private. (UF Bowdlerizer,
Expurgator)</item>
<label>Choreographer [chr] </label><item>Use for a person who
composes or arranges dances or other movements (e.g., "master of
swords") for a musical or dramatic presentation or
entertainment.</item>
<label>Client [cli] </label><item>Use for a person or organization
for whom another person or organization is acting.</item>
<label>Collaborator [clb] </label><item>Use for a person or
corporate body that takes a limited part in the elaboration of a work
of another author or that brings complements (e.g., appendices,
notes) to the work of another author</item>
<label>Collector [col] </label><item>Use for a person who has
brought together material from various sources, which has been
arranged, described, and cataloged as a collection. The collector is
neither the creator of the material nor the person to whom
manuscripts in the collection may have been addressed.</item>
<label>Collotyper [clt]</label><item></item>
<label>Commentator [cmm] </label><item>Use for a person who
provides interpretation, analysis, or a discussion of the subject
matter on a recording, motion picture, or other audiovisual
medium.</item>
<label>Compiler [com] </label><item>Use for a person who produces a
work or publication by selecting and putting together material from
the works of various persons or bodies.</item>
<label>Complainant [cpl] </label><item>Use for the party who
applies to the courts for redress, usually in an equity
proceeding.</item>
<label>Complainant-appellant [cpt] </label><item>Use for a
complainant who takes an appeal from one court or jurisdiction to
another to reverse the judgment, usually in an equity
proceeding.</item>
<label>Complainant-appellee [cpe] </label><item>Use for a
complainant against whom an appeal is taken from one court or
jurisdiction to another to reverse the judgment, usually in an equity
proceeding.</item>
<label>Composer [cmp] </label><item>Use for a person who creates a
musical work, usually a piece of music in manuscript or printed
form.</item>
<label>Compositor [cmt] </label><item> (UF Typesetter)</item>
<label>Conceptor [ccp] </label><item>Use for a person or corporate
body responsible for the original idea on which a work is based, this
includes the scientific author of an audio-visual item and the
conceptor of an advertisement.</item>
<label>Conductor [cnd] </label><item>Use for a person who directs a
performing group (orchestra, chorus, opera, etc.).</item>
<label>Consultant [csl] </label><item>Use for the person called upon
for professional advice or services in a specialized field of
knowledge or training.</item>
<label>Contestant [cos] </label><item>Use for the party who
opposes, resists, or disputes, in a court of law, a claim, decision,
result, etc.</item>
<label>Contestant-appellant [cot] </label><item>Use for a
contestant who takes an appeal from one court of law or jurisdiction
to another to reverse the judgment.</item>
<label>Contestant-appellee [coe] </label><item>Use for a contestant
against whom an appeal is taken from one court of law or jurisdiction
to another to reverse the judgment.</item>
<label>Contestee [cts] </label><item>Use for the party defending a
claim, decision, result, etc. being opposed, resisted, or disputed in
a court of law.</item>
<label>Contestee-appellant [ctt] </label><item>Use for a contestee
who takes an appeal from one court or jurisdiction to another to
reverse the judgment.</item>
<label>Contestee-appellee [cte] </label><item>Use for a contestee
against whom an appeal is taken from one court or jurisdiction to
another to reverse the judgment.</item>
<label>Contractor [ctr] </label><item>Use for the person or
corporate body who enters into a contract with another person or
corporate body to perform a specific task.</item>
<label>Copyright claimant [cpc] </label><item>Use for the person
listed as as copyright owner at the time of registration. Copyright
can be granted or later transfered to another person or agent, at
which time the claimant becomes the copyright holder.</item>
<label>Copyright holder [cph]</label><item></item>
<label>Corrector [crr] </label><item>Use for a corrector of
manuscripts, such as the scriptorium official who corrected the work
of a scribe. For printed matter, use Proofreader [pfr].</item>
<label>Correspondent [crp] </label><item>Use for a person or
organization who was either the writer or recipient of a letter or
other communication.</item>
<label>Costume designer [cst] </label><item>Use for a person who
designs or makes costumes, fixes hair, etc., for a musical or
dramatic presentation or entertainment.</item>
<label>Counterfeiter </label><item type='role.USE'>USE Forger</item>
<label>Curator of an exhibition [cur] </label><item>Use for a person
who is responsible for conceiving and organizing an exhibition.</item>
<label>Dancer [dnc] </label><item>Use for a person who principally
exhibits dancing skills in a musical or dramatic presentation or
entertainment.</item>
<label>Dedicatee [dte] </label><item>Use for a person or
organization to whom a book, manuscript, etc., is dedicated (not the
recipient of a gift).</item>
<label>Dedicator [dto] </label><item>Use for the author of a
dedication, which may be a formal statement or in epistolary or verse
form.</item>
<label>Defendant [dfd] </label><item>Use for the party defending or
denying allegations made in a suit and against whom relief or
recovery is sought in the courts, usually in a legal action.</item>
<label>Defendant-appellant [dft] </label><item>Use for a defendant
who takes an appeal from one court or jurisdiction to another to
reverse the judgment, usually in a legal action.</item>
<label>Defendant-appellee [dfe] </label><item>Use for a defendant
against whom an appeal is taken from one court or jurisdiction to
another to reverse the judgment, usually in a legal action.</item>
<label>Delineator [dln] </label><item>Use for a person or
organization executing technical drawings from others' designs.</item>
<label>Depositor [dpt] </label><item>Use for a person or
organization placing material in the physical custody of a library or
repository without transferring the legal title.</item>
<label>Designer [dsr] </label><item>Use for a person or
organization responsible for design if specific codes (e.g., [bkd],
[tyd]) are not desired.</item>
<label>Designer of binding </label><item type='role.USE'>USE Binding
designer </item>
<label>Designer of book </label><item type='role.USE'>USE Book designer </item>
<label>Designer of bookjacket </label><item type='role.USE'>USE
Bookjacket designer </item>
<label>Designer of bookplate </label><item type='role.USE'>USE
Bookplate designer </item>
<label>Designer of type </label><item type='role.USE'>USE Type
designer </item>
<label>Director [drt] </label><item>Use for a person who is
responsible for the general management of a work or who supervises
the production of a performance for stage, screen, or sound
recording.</item>
<label>Dissertant [dis] </label><item>Use for a person who presents
a thesis for a university or higher-level educational degree.</item>
<label>Distributor [dst] </label><item>Use for an agent or agency
that has exclusive or shared marketing rights for an item.</item>
<label>Donor [dnr] </label><item>Use for the donor of a book,
manuscript, etc., to its present owner. Donors to previous owners
are designated as Former owner [fmo] or Inscriber [ins].</item>
<label>Draftsman [drm] </label><item>Use for the person who prepares
technical or mechanical drawings. (UF Technical draftsman)</item>
<label>Dubious author [dub] </label><item>Use for a person or
corporate body to which authorship has been dubiously or incorrectly
ascribed.</item>
<label>Editor [edt] </label><item>Use for a person who prepares for
publication a work not primarily his/her own, such as by elucidating
text, adding introductory or other critical matter, or technically
directing an editorial staff.</item>
<label>Electrotyper [elt]</label><item></item>
<label>Engineer [eng] </label><item>Use for a person or
organization that is responsible for technical planning and design,
particularly with construction.</item>
<label>Engraver [egr]</label><item></item>
<label>Etcher [etr]</label><item></item>
<label>Expert [exp] </label><item>Use for a person in charge of the
description and appraisal of the value of goods, particularly rare
items, works of art, etc. (UF Appraiser)</item>
<label>Expurgator </label><item type='role.USE'>USE Censor</item>
<label>Film editor [flm] </label><item>Use for an editor of a
motion picture film. This term is used regardless of the medium upon
which the motion picture is produced or manufactured (e.g., acetate
film, video tape). (UF Motion picture editor)</item>
<label>Forger [frg] </label><item> (UF Counterfeiter)</item>
<label>Former owner [fmo] </label><item>Use for the person or
organization who owned an item at any time in the past. Includes
those to whom the material was once presented. The person or
organization giving the item to the present owner is designated as
Donor [dnr]</item>
<label>Funder [fnd] </label><item>Use for the person or agency that
furnished financial support for the production of the work.</item>
<label>Graphic technician </label><item type='role.USE'>USE Artist</item>
<label>Honoree [hnr] </label><item>Use for the person in memory or
honor of whom a book, manuscript, etc. is donated. (UF
Memorial)</item>
<label>Host [hst] </label><item>Use for the person who is invited
or regularly leads a program (often broadcast) that includes other
guests, performers, etc. (e.g., talk show host).</item>
<label>Illuminator [ilu]</label><item></item>
<label>Illustrator [ill] </label><item>Use for the person who
conceives, and perhaps also implements, a design or illustration,
usually to accompany a written text.</item>
<label>Imprimatur </label><item type='role.USE'>USE Licensor</item>
<label>Inscriber [ins] </label><item>Use for the person who signs a
presentation statement.</item>
<label>Instrumentalist [itr] </label><item>Use for a person who
principally plays an instrument in a musical or dramatic presentation
or entertainment.</item>
<label>Interviewee [ive]</label><item></item>
<label>Interviewer [ivr]</label><item></item>
<label>Inventor [inv]</label><item></item>
<label>Investigator </label><item type='role.USE'>USE Originator</item>
<label>Joint author </label><item type='role.USE'>USE Author</item>
<label>Landscape architect [lsa] </label><item>Use for the person or
organization whose work involves coordinating the arrangement of
existing and proposed land features and structures.</item>
<label>Lender [len] </label><item>Use for a person or organization
permitting the temporary use of a book, manuscript, etc., such as for
photocopying or microfilming.</item>
<label>Libelant [lil] </label><item>Use for the party who files a
libel in an ecclesiastical or admiralty case.</item>
<label>Libelant-appellant [lit] </label><item>Use for a libelant
who takes an appeal from one ecclesiastical court or admiralty to
another to reverse the judgment.</item>
<label>Libelant-appellee [lie] </label><item>Use for a libelant against whom
an appeal is taken from one ecclesiastical court or admiralty to
another to reverse the judgment.</item>
<label>Libelee [lel] </label><item>Use for the party against whom a
libel has been filed in an ecclesiastical court or admiralty.</item>
<label>Libelee-appellant [let] </label><item>Use for a libelee who
takes an appeal from one ecclesiastical court or admiralty to another
to reverse the judgment.</item>
<label>Libelee-appellee [lee] </label><item>Use for a libelee
against whom an appeal is taken from one ecclesiastical court or
admiralty to another to reverse the judgment.</item>
<label>Librettist [lbt] </label><item>Use for the writer of the
text of an opera, oratorio, etc.</item>
<label>Licensee [lse] </label><item>Use for the original recipient
of the right to print or publish.</item>
<label>Licensor [lso] </label><item>Use for the signer of the
license, impri- matur, etc. (UF Imprimatur)</item>
<label>Lithographer [ltg] </label><item>Use for the person who
prepares the stone or plate for lithographic printing, including a
graphic artist creating a design directly on the surface from which
printing will be done.</item>
<label>Lyricist [lyr] </label><item>Use for the writer of the text
of a song.</item>
<label>Memorial </label><item type='role.USE'>USE Honoree</item>
<label>Metadata contact [mdc] </label><item>Use for the person or
organization primarily responsible for compiling and maintaining the
original description of a metadata set (e.g., geospatial metadata
set).</item>
<label>Metal-engraver [mte]</label><item></item>
<label>Moderator [mod] </label><item>Use for the person who leads a
program (often broadcast) where topics are discussed, usually with
participation of experts in fields related to the discussion.</item>
<label>Monitor [mon] </label><item>Use for a person or organization
that supervises compliance with the contract and is responsible for
the report and controls its distribution. Sometimes referred to as
the grantee, or controlling agency.</item>
<label>Motion picture editor </label><item type='role.USE'>USE Film
editor </item>
<label>Musician [mus] </label><item>Use for the person who performs
music or contributes to the musical content of a work when it is not
possible or desirable to identify the function more precisely.</item>
<label>Narrator [nrt] </label><item>Use for the speaker who relates
the particulars of an act, occurrence, or course of events.</item>
<label>Originator [org] </label><item>Use for the author or agency
performing the work, i.e., the name of a person or organization
associated with the intellectual content of the work. This category
does not include the publisher or personal affiliation, or sponsor
except where it is also the corporate author. Includes a person
designated in the work as investigator or principal investigator. (UF
Principal investigator)</item>
<label>Other [oth] </label><item>Use for relator codes from other
formats which have no equivalent in USMARC or for terms which have
not been assigned a code.</item>
<label>Papermaker [ppm]</label><item></item>
<label>Patent holder [pth]</label><item></item>
<label>Patron [pat] </label><item>Use for the person responsible for
commissioning a work. Usually a patron uses his or her means or
influence to support the work of artists, writers, etc. This
includes those who commission and pay for individual works.</item>
<label>Performer [prf] </label><item>User for a person who exhibits
musical or acting skills i a musical or dramatic presentation or
entertainment, if specific codes for those functions ([act], [dnc],
[itr], [voc], etc.) are not used. If specific codes are used, [prf]
is used for a person whose principal skill is not known or
specified.</item>
<label>Photographer [pht] </label><item>Use for the person or
organization responsible for taking photographs, whether they are
used in their original form or as reproductions.</item>
<label>Plaintiff [ptf] </label><item>Use for the party who
complains or sues in court in a personal action, usually in a legal
proceeding.</item>
<label>Plaintiff-appellant [ptt] </label><item>Use for a plaintiff
who takes an appeal from one court or jurisdiction to another to
reverse the judgment, usually in a legal proceeding.</item>
<label>Plaintiff-appellee [pte] </label><item>Use for a plaintiff
against whom an appeal is taken from one court or jurisdiction to
another to reverse the judgment, usually in a legal proceeding.</item>
<label>Platemaker [plt]</label><item></item>
<label>Plates, Printer of </label><item type='role.USE'>USE Printer
of Plates </item>
<label>Principal investigator </label><item type='role.USE'>USE
Originator</item>
<label>Printer [prt] </label><item>Use for the person or
organization who prints texts, whether from type or plates.</item>
<label>Printer of plates [pop] </label><item>Use for the person or
organization who prints illustrations from plates. (UF Plates,
Printer of)</item>
<label>Process contact [prc] </label><item>Use for a person or
organization primarily responsible for performing or initiating a
process, such as is done with the collection of metadata sets.</item>
<label>Producer [pro] </label><item>Use for a person who is
responsible for the making of a motion picture, including business
aspects, management of the productions, and the commercial success of
the work.</item>
<label>Producer of book </label><item type='role.USE'>USE Book producer </item>
<label>Production personnel [prd] </label><item>Use for a person
who is associated with the production (props, lighting, special
effects, etc.) of a musical or dramatic presentation or
entertainment.</item>
<label>Programmer [prg] </label><item>Use for a person or corporate
body responsible for the creation and/or maintenance of computer
program design documents, source code, and machine-executable digital
files and supporting documentation.</item>
<label>Promoter </label><item type='role.USE'>USE Thesis advisor </item>
<label>Proofreader [pfr] </label><item>Use for a person who
corrects printed matter. For manuscripts, use Corrector [crr].</item>
<label>Publisher [pbl]</label><item></item>
<label>Publishing director [pbd] </label><item>Use for a person who
presides over the elaboration of a collective work to ensure its
coherence or continuity. This includes editors-in-chief, literary
editors, editors of series, etc.</item>
<label>Recipient [rcp] </label><item>Use for the person to whom
correspondence is addressed.</item>
<label>Recording engineer [rce] </label><item>Use for a person who
supervises the technical aspects of a sound or video recording
session.</item>
<label>Redactor [red] </label><item>Use for a person who writes or
develops the framework for an item without being intellectually
responsible for its content.</item>
<label>Renderer [ren] </label><item>Use for the draftsman who
prepares drawings of architectural designs (i.e., renderings) in
accurate, representational perspective to show what the project will
look like when completed.</item>
<label>Respondent [rsp] </label><item>Use for the party who makes
an answer to the courts pursuant to an application for redress,
usually in an equity proceeding.</item>
<label>Respondent-appellant [rst] </label><item>Use for a
respondent who takes an appeal from one court or jurisdiction to
another to reverse the judgment, usually in an equity
proceeding.</item>
<label>Respondent-appellee [rse] </label><item>Use for a respondent
against whom an appeal is taken from one court or jurisdiction to
another to reverse the judgment, usually in an equity
proceeding.</item>
<label>Reviewer [rev] </label><item>Use for a person or corporate
body responsible for the review of book, motion picture, performance,
etc.</item>
<label>Rubricator [rbr]</label><item></item>
<label>Scenarist [sce] </label><item>Use for the author of a motion
picture screenplay.</item>
<label>Scientific advisor [sad] </label><item>Use for a person who
brings scientific, pedagogical, or historical competence to the
conception and realization on a work, particularly in the case of
audio-visual items.</item>
<label>Scribe [scr] </label><item>Use for a person who makes
pen-facsimiles of printed matter, as well as for an amanuensis, and
for a writer of manuscripts proper.</item>
<label>Sculptor [scl] </label><item>Use when the more general term
Artist [art] is not desired.</item>
<label>Secretary [sec] </label><item>Use for a recorder, redactor,
or other person responsible for expressing the views of a corporate
body.</item>
<label>Signer [sgn] </label><item>Use for the person whose
signature appears without a presentation or other statement
indicative of provenance. When there is a presentation statement,
use Inscriber [ins].</item>
<label>Singer [sng] </label><item>Use for a person who uses his or
her voice with or without instrumental accompanyment to produce
music. A singer's performance may or may not include actual
words.</item>
<label>Speaker [spk] </label><item>Use for a person who
participates in a program (often broadcast) and makes a formalized
contribution or presentation generally prepared in advance.</item>
<label>Sponsor [spn] </label><item>Use for the person or agency
that issued a contract or under the auspices of which a work has been
written, printed, published, etc.</item>
<label>Stereotyper [str]</label><item></item>
<label>Supposed name </label><item type='role.USE'>USE Attributed name </item>
<label>Surveyor [srv] </label><item>Use for a person or
organization who does measurements of tracts of land, etc. to
determine location, forms, and boundaries.</item>
<label>Thesis advisor [ths] </label><item>Use for the person under
whose supervision a degree candidate develops and presents a thesis,
memoire, or text of a dissertation. (UF Promoter)</item>
<label>Transcriber [trc] </label><item>Use for a person who
prepares a handwritten or typewritten copy from original material,
including from dictated or orally recorded material. For makers of
pen-facsimiles, use Scribe [scr].</item>
<label>Translator [trl] </label><item>Use for a person who renders
a text from one language into another, or from an older form of a
language into the modern form.</item>
<label>Type designer [tyd] </label><item>Use for the person who
designed the type face used in a particular item. (UF Designer of
type)</item>
<label>Typesetter </label><item type='role.USE'>USE Compositor</item>
<label>Typographer [tyg] </label><item>Use for the person primarily
responsible for choice and arrangement of type used in an item. If
the typographer is also responsible for other aspects of the graphic
design of a book (e.g., Book designer [bkd]), codes for both
functions may be needed.</item>
<label>Vocalist [voc] </label><item>Use for a person who
principally exhibits singing skills in a musical or dramatic
presentation or entertainment.</item>
<label>Wood-engraver [wde]</label><item></item>
<label>Writer of accompanying material [wam] </label><item>Use for a
person who writes significant material which accompanies a sound
recording or other audiovisual material.</item>
</list>
</div>
<!-- ==================================================================== -->
<div><head>Notes to be edited in</head>
Canonical inherits; true on osisText, false on header/note/reference.
Head is canonical! Warn.
<p>
What should you do in a comm if you quote a verse? reference? osisID
on q? osisRef on q?
</p>
<p>
How do you tag strings like "Matthew 20:28" at the end of a quotation?
</p>
<p>
If a paragraph, div, or other unit exactly comprises one or more
verses, set the appropriate osisID value on the paragraph or other
unit, and do not encode a redundant verse.
</p>
<p>
Just how much should "signed" and "closer" include?
</p>
<p>
Title in header example should not contain date; should add pubdate field
</p>
<p>
Elements should not be represented via milestones if they can be
represented as regular elemnts (that is, if they do not cross
boundaries in some funny way).
</p>
<p>
Time osisIDs need a normative reference system associated -- reserve
'time' as the name?
</p>
</div>
<!--
=======================================================================
-->
<div><head>The Bible Technology Group</head>
<p>
BTG is a joint effort that has been supported most tangibly by the
American Bible Society and the Society for Biblical Literature, as
well as by the United Bible Societies, numerous national Bible
Societies, the Summer Institute of Linguistics, and othe
organizations.
</p>
<p>
Among the contributors to this work have been:
</p>
<list>
<item>Patrick Durusau, SBL (primary editor)</item>
<item>Steve Derose (BTG Chair and co-editor)</item>
<item>Kees DeBlois, UBS (BTG Vice-chair)</item>
<item>Kirk Lowery, Westminster Hebrew Institute (chair,
Linguistic Annotation WG)</item>
<item>Troy Griffiths, Crosswire</item>
<item>Chris Little, </item>
<item>Todd Tillinghast, </item>
<item>Adina Hamik, Nida Institute</item>
<item>Harry Plantinga, Calvin College/CCEL</item>
<item>Mike Perez, American Bible Society</item>
<item>Dennis Drescher, SIL</item>
<item>Nathan Miles, SIL</item>
<item>Robert Hodgson, Nida Institute</item>
<item>John Walters, American Bible Society</item>
</list>
<p>
The work of BTG has also been greatly enhanced by many other members
of these and other organizations, who have responded to drafts, made
numerous, useful, and sometimes essential recommendations, and
encoded texts to test the schemas for usability, consistency, and
other virtues. Especially notable among these have been Robin Cover,
Jonathan Robie, and Bob Pritchett.
</p>
<p>The official Website for BTG is http://www.bibletechnologies.net,
and much additional information can be found there.</p>
</div>
</div>
</div>
</body>
</text>
</TEI.2>
--============_-1154868386==_============--