[osis-users] Question about Commentary Osis

Sat Jan 5 09:04:00 MST 2013

Pola,
The tags you tried are not OSIS and will not validate against the OSIS schema.

I'll try to explain why it may seem like a good idea to use HTML (or even xhtml) in OSIS: Because it works in some applications that consume OSIS.

For example:

Many of the SWORD frontends use an HTML renderer to render content, passing to it what comes out of the render filters. Many times the render filters pass the xml tags that they are not expecting. Other times they strip them out.

The HTML renderers vary in their ability to render all of HTML. Earlier versions of Xiphos had a fairly limited renderer. They are moving to a better renderer and it may already be available. JSword is stuck with an early version of HTML.

If the frontend does not convert the OSIS to HTML but to some other form (e.g. RTF) then it is most likely the non-OSIS tags will not be handled in an acceptable way.

That it works in one application and not another should be an indication that what you have done is some how not quite right.

Regarding the specific problems you are having with the output not showing up correctly in an application, that is an application problem, not an OSIS problem. This list is concerned with what is proper OSIS not with applications that render OSIS. If you have a specific problem with an application then that application's forum or mailing list is a better place to ask the question.

Regarding titles in a commentary. By default the canonical attribute of a title is "false". This default is fine for Bibles, but not for commentaries. You'll need to set it to "true". SWORD applications treat titles with a toggle when canonical="false" but not with canonical="true". It may be that the application needs to have the toggle set to show titles (it may be called headings).

The canonical attribute is also false for div, which is probably not true for a commentary. In the context of a commentary, canonical distinguishes between what is part of the commentary and what is not (example, an editorial comment/footnote).

The OSIS equivalent of <br /> is <lb />.

The OSIS equivalent of <b> and <strong> is <hi type="bold">.

There is no OSIS equivalent of <font>. That is a rendering directive. OSIS is all about structure. Rendering is left to applications.

There is no OSIS equivalent to <hr />. The closest is <hi type="underline">. But still this seems to want to control rendering, which is not in the realm of OSIS, but applications.

Your use of <head> is not right. It is only allowed as a child of <table>, <list> and <castGroup>. In those contexts, it is an equivalent of a title.

Regarding references, it'd be best to have one issue per email. You didn't give enough information for us to try to help figure out what is not working.

In Him,
	DM

On Jan 4, 2013, at 1:32 PM, Pola Edward <5001 at hotmail.com> wrote:

> Thanks again Chris for your help .
> Today I spent my day trying different tags in OSIS ,
> 
> I'll use Head for titles since Title doesn't display anything, I write it in <div annotateRef="Matt.1.1" annotateType="commentary" type="section">
> But <head><font size="+1"><b>Head Tile Here</b></font></head> Worked 
> 
> Also I'll use <hr /> After Titles to make the output more readable 
> 
> and will separate Paragraphs with Double <br />
> 
> I couldn't get the references to work by anyway, and tried it in different forms .
> 
> I'll Modify the program to render this extra output, Please reply me with your opinions 
> 
> 
> > Date: Mon, 31 Dec 2012 00:08:06 -0800
> > From: chrislit at crosswire.org
> > To: osis-users at crosswire.org
> > Subject: Re: [osis-users] Question about Commentary Osis
> > 
> > On 12/30/2012 8:43 PM, pola ashraf wrote:
> > > Hi everyone,
> > > I don't know the suitable list to submit this question to, so i posted
> > > it to Sword-Devel and Osis-Users
> > >
> > > Now, We've made a very simple commentary editor, so non-technical data
> > > entry can use it easily to generate valid XML
> > > http://s9.postimage.org/r6vtq6hjj/Commentary_Editor.png
> > >
> > > We'll use it to make Arabic Commentaries, But i have some questions
> > > about OSIS XML
> > >
> > > *The Main Output*
> > > the program above make this output based on the chosen options
> > >
> > > <div type="section" annotateType="commentary" annotateRef="Gen.1.1"><p>
> > > Blah Blah Blah
> > > Blah Blah
> > > </p></div>
> > >
> > > Now,
> > > How to Add Titles to the commentary text, So Verse 1 Commentary could
> > > start with title explaining the topic of the Verse/Verse Range ?
> > 
> > <title>....</title>
> > 
> > Some of the established title types can be seen here: 
> > http://www.crosswire.org/osis/schemas/osisCore.2.1.1.xsd.html#h-1757748498
> > 
> > For a title identifying the verse under discussion you could use:
> > <title type="scope"><reference osisRef="...">...</reference></title>
> > 
> > > What are the suitable tags for references (to verses, or general
> > > references) ?
> > 
> > <reference osisRef="...">...</reference>
> > 
> > > What are the suitable tags for Book intro ?
> > 
> > <div type="introduction">...</div>
> > 
> > Just place this within your book <div> but before any of the commentary 
> > section <div>s.
> > 
> > > This is an example for the Commentary Source text
> > > http://st-takla.org/pub_Bible-Interpretations/Holy-Bible-Tafsir-02-New-Testament/Father-Tadros-Yacoub-Malaty/01-Engeel-Matta/Tafseer-Engil-Mata__01-Chapter-01.html
> > > http://popekirillos2.bizhat.com/bible/tafseer/matew1.htm
> > >
> > > As you can see in the links above the commentary contains a lot of
> > > titles and references
> > >
> > > Happy New Year and Merry Christmas
> > > GOD Bless you all and Bless your service
> > >
> > > Pola
> > 
> > I'm not sure whether this is really what you wanted, so let us know if 
> > your need further guidance.
> > 
> > --Chris
> > 
> > 
> > _______________________________________________
> > osis-users mailing list
> > osis-users at crosswire.org
> > http://www.crosswire.org/mailman/listinfo/osis-users
> _______________________________________________
> osis-users mailing list
> osis-users at crosswire.org
> http://www.crosswire.org/mailman/listinfo/osis-users

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.crosswire.org/pipermail/osis-users/attachments/20130105/fceaf749/attachment.html>