OSIS Commentaries

From CrossWire Bible Society
Revision as of 18:57, 27 February 2008 by Dmsmith (talk | contribs) (Initial discussion of OSIS Commentary construction.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Introduction

In SWORD a commentary is structured just like a Bible. The difference is that instead of verse text the commentary has discussion about verse text.

Markup

Until osis2mod is changed to support commentaries, one can markup a commentary with verse tags:

<verse osisID="Gen.1.1"><p>Blah blah...</p></div>

The fundamental mechanism of markup for an OSIS commentary is:

<div type="section" annotateType="commentary" annotateRef="Gen.1.1"><p>Blah blah...</p></div>

A couple of things to note:

type
This attribute can have any valid value or even be absent. osis2mod will not use this value.

annotateType
This attribute must have the value commentary will be used to know that we are processing an entry for a commentary.

annotateRef
This attribute can contain any valid osisRef, but the references must not have a work prefix, such as 'Bible:'. The default for all references and the only ones that SWORD supports at this time are Bible references. We'll tackle work prefixes at a later date.

A single reference uses single "osisID":

annotateRef="Gen.1.1"

A range will be of the form, "osisID-osisID":

annotateRef="Gen.1.1-Gen.2.3"

where the first and the second reference are complete osisIDs and they are separated by a - (and no spaces). And the first reference must precede the second.

Discontinuous references are to be separated by whitespace, "osisRef osisRef". For example:

annotateRef="Gen.1.1 Gen1.5"