[jsword-devel] Key issues

[Tonny Kohar]

Hi,

+ 1 for the "/" (slash) separator than "." (dot) separator.
So it will be look like something like
sword://KJV/Gen.1 rathen than sword://KJV.Gen.1
bible://KJV/Gen.1 rathen than bible://KJV.Gen.1
aka
[scheme://][path/][#][fragment]
scheme = sword,bible,commentary,...
path = name of the book eg: KJV, ESV
fragment/Reference = the key eg: GEN.1.1

Any idea regarding protocol scheme conventions ?
sword:// -> generic scheme
bible:// -> bible scheme
dictionary:// or def:// -> dictionary scheme
daily:// -> daily devotions
glossary:// - > glossary
etc

Does the syntax already agreed among developer and become recommendation ?

Cheers
Tonny Kohar


On Wed, May 14, 2008 at 3:47 AM, DM Smith <dmsmith555 at yahoo.com> wrote:
> DM Smith wrote:
>  > Brian Fernandes wrote:
>  >
>  >>> Could you not make the URL bible://ESV.gen.1?  That way, you keep all
>  >>> the info you need to make the right choices, independent of what's in
>  >>> the combo.  I don't know how difficult it would be to rework the
>  >>> protocol handler, though...
>  >>>
>
> >>> Unfortunately, I do not have a better suggestion, but will try to think
>  >>> one up.
>  >>>
>  >>>
>  >
>  > I think you are on the right track that you want a simple separator
>  > character that the browser can handle.
>  >
>  > I'm going to ask on sword-devel for their input.
>  >
>  >
>  >>  > As you can guess, the key to a GenBook entry is the entire path from
>  >>  > the root. Sword reserves '/' as a path separator.
>  >>
>  >> Cool, I will give that a try, if JSword does not parse it already I can
>  >> easily build it myself. I assume this means keys may not have "/" in
>  >> their names? But / does seem like the kind of character which could make
>  >> an appearance in a page heading? (though I have not seen one yet).
>  >>
>  >>
>  >
>  > I'll also ask this too.
>
>  The direction given by sword-devel:
>  The protocol should be sword:// not bible:// to be follow the standard
>  that the other Sword projects follow.
>
>  bible:// indicates that we are working with a Bible, but is misleading
>  when using non-bible modules.
>
>  After the protocol the suggestion is to have the module name followed by
>  a / and then the reference, as in:
>
> sword://KJV/Gen.1.1
>
>  For parallel view, I suggested and several others thought well of the
>  idea that the module name is a comma separated list:
>  sword://KJV,ESV/Gen.1
>
>  For GenBooks, which have hierarchical keys, there were two suggestions:
>  1) Use '/' as a path separator and use URL encoding for the spaces.
>  2) Use url encoding for the '/' and for the spaces.
>
>  MacSword has a mechanism to pass features, prefixing them to the request:
>  sword://strongsNumbers&versePerLine@KJV/Gen.1
>
>  I think it would be better to use ? at the end and then have the list as
>  this follows the URL syntax, as in:
>  sword://KJV/Gen.1?strongsNumbers=Y&versePerLine=Y
>
>  I don't think there is a standard set of these. I think it really boil
>  down to what the UI provides.
>
>
>
>  -- DM
>
>
>  _______________________________________________
>  jsword-devel mailing list
>  jsword-devel at crosswire.org
>  http://www.crosswire.org/mailman/listinfo/jsword-devel
>



-- 
Citra FX Photo Effects
imagine, design, create ...
http://www.kiyut.com