[sword-devel] OSIS difficulties and the module creation wiki

[DM Smith]

Daniel,

Sorry for not replying sooner. For an example of OSIS that works well  
for Sword look at www.crosswire.org/~dmsmith/kjv2006. At the bottom  
of the page is a link OSIS XML to the KJV in OSIS.

Additionally, you can use BibleDesktop's View Source to look at other  
OSIS modules.

Yes we should have a page outlining the best practices for writing a  
Bible in OSIS from a Sword perspective. I've started one here: http:// 
www.crosswire.org/wiki/index.php/OSIS_Bibles

You can add entries for things you'd like to have answered. And if  
you have good examples, please add them.

With regard to your earlier questions, you can use the kjv.xml file  
to find examples answering them.

Elements that stand between verses, chapters and books are especially  
difficult in Sword and osis2mod tries it's best to put them someplace  
reasonable. This amounts to one of three places:
1) The intro to a Book or Chapter. These are synthetic verses. For  
example, Gen.0 is the intro to Genesis. Gen.1.0 is the intro to  
Genesis 1.
2) The last verse.
3) The next verse.

Whether an element is put into one of these locations depends on its  
effect. In part this is because, at the current time, an OSIS Sword  
module does not retain the verse element. So it does not know for  
certain where the verse number should go.

For this reason, elements which would generate whitespace are put in  
the last verse. Titles are, for the most part, put in the next verse  
but marked as "preverse" by osis2mod.

Hope this helps.

In Him,
	DM

On Sep 20, 2007, at 10:22 PM, Daniel Owens wrote:

> Sorry for the late delay in my response--we had some medical  
> challenges in our family necessitating an evacuation, so I am now  
> away from my desktop and using my wife's laptop, which only has  
> Windows installed.
>
> I like the idea that OSIS tagging, if it is legal, should work. I  
> will go back and do my best to check the tagging against the OSIS  
> 2.1.1 schema first to make sure I have done things right. After  
> that I will create a module and check to make sure that it is still  
> creating the problem and then file bug reports and send the module  
> if there are still problems.
>
> I have a suggestion for improving the wiki for module creation. The  
> documentation on module creation is detailed for the *.conf files,  
> but there isn't much available in the way of OSIS example xml  
> documents. The Bible Technologies Group website has some OSIS 2.0  
> examples, and that is what I used as a model for my tagging since  
> the CEV example has almost all the features that I needed for the  
> translation I am working with (including notes, section headings,  
> ect.). I work better from concrete examples than the lengthy user  
> manual for OSIS 2.1.1, which I am now scouring for answers to my  
> questions. When I created the module and ran into problems I wasn't  
> sure whether the problem was the various Sword front-ends (Gnome  
> Sword did fine while most others had problems) or my tagging. If  
> someone could create some short example xml files to put on the  
> module creation wiki, that would help average module creators like  
> me compare our tagging with something that is KNOWN to work in the  
> Sword library. Short examples of prose and poetry Bible text with  
> common features, a commentary, a general book, and a dictionary  
> would be really useful. They need not be complete--partial  
> documents with enough to demonstrate the features supported by  
> Sword would go a long way in helping average module creators  
> imagine what their xml document needs to look like.
>
> Daniel
>
> Eeli Kaikkonen wrote:
>> On Sat, 25 Aug 2007, Daniel Owens wrote:
>>
>>
>>> I'm working on tagging a bible in OSIS, and when I use osis2mod the
>>> module shows up in Bibletime, but there are a few quirks I'd  
>>> appreciate
>>> help with. I followed the examples from the OSIS website.
>>>
>> ...
>>
>>> Can anyone advise me on how to fix my tagging?
>>>
>> My opinion is that if your tagging is "legal" osis you should not  
>> need
>> to change it but the library/frontends should be fixed. It may  
>> very well
>> be that the problem is in "filters" which translate the osis text  
>> into
>> html or something else. BibleTime has it's own filters but a bug can
>> be in both Sword's and BibleTime's filter.
>>
>> Just now I'm too hungry and busy to look at it but I suggest that  
>> if you
>> don't find anything wrong with you tagging you could file this as
>> BibleTime bug. We just need access to your module.
>>
>>   Yours,
>> 	Eeli Kaikkonen (Mr.), Oulu, Finland
>> 	e-mail: eekaikko at mailx.studentx.oulux.fix (with no x)
>>
>> _______________________________________________
>> 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
>>
>>
> _______________________________________________
> 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 --------------
An HTML attachment was scrubbed...
URL: http://www.crosswire.org/pipermail/sword-devel/attachments/20070920/14843c68/attachment.html