[sword-devel] OSIS format and SWORD utils

DM Smith dmsmith at crosswire.org
Fri Feb 14 14:54:12 MST 2014


We refer to the two formats as BSP and BCV, or Book/Section/Paragraph and Book/Chapter/Verse.

All of our programs use BCV and osis2mod ensures that the module's representation internally is BCV.

Given BSP, osis2mod will convert it to BCV.

If you need markup that crosses Chapter boundaries (starts in one chapter and ends in another) or Verse boundaries (starts and ends in different verses) then you'll want to do BSP.

If you merely have text but little or no markup, BCV may do just fine.

Typically, I'll use containers for everything and see what breaks when validated against the schema. If needed I convert verse start and ends to milestoned version. And try again.

One of the advantages of starting in this form is you can find silly assumptions about the input that simply were not true.

Things to watch out for:
Ending things immediately after a verse start, when it should be before a verse start. E.g. a section div, a line group, a paragraph
Ending things immediately before a verse end, when it should be after a verse end. E.g. a section div
Starting things immediately after a verse start, when it should be before a verse start. E.g. a section div
Starting things immediately before a verse end, when it should be after a verse end. E.g. a section div, a title

By and large, elements of document structure should be between verses.

Hope this helps.

In His Service,
	DM


On Feb 14, 2014, at 3:22 PM, Chris Burrell <chris at burrell.me.uk> wrote:

> Hello
> 
> I'm looking to create some OSIS modules from some proprietary format. I recall seeing two types of OSIS markups. The fully nested version (i.e. 1 verse element contains all verse contents) and a more linear version (1 verse element contains sID and eID and the contents are not nested).
> 
> I'm assuming the latter is the more formal/correct version and more flexible as it would allow to mark-up cross-verse content?
> 
> Is there any reason why I've come across both formats? Do the Sword utilities convert from the latter to the former?
> 
> Chris
> 
> _______________________________________________
> sword-devel mailing list: sword-devel at crosswire.org
> http://www.crosswire.org/mailman/listinfo/sword-devel
> Instructions to unsubscribe/change your settings at above page

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4145 bytes
Desc: not available
URL: <http://www.crosswire.org/pipermail/sword-devel/attachments/20140214/12a9ba04/attachment.p7s>


More information about the sword-devel mailing list