Frontends:URI Standard

From CrossWire Bible Society

Revision as of 17:50, 26 July 2012 by David Haslam (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Some SWORD front-ends handle bible: or sword: as URIs. This necessitates having a standard for new and existing front-ends. A Bible URI standard is also necessary for Bookmarks Standard.


Current situation


Xiphos handles URIs in following format:


This section needs adding.


PocketSword currently internally handles the standard sword://module/key URIs but doesn't yet register itself with the OS to handle links from other apps. This needs to happen at some point! Probably for v1.3.0, when I refactor more of the code...... As PocketSword doesn't yet handle genbooks, I haven't looked into what the URI would be for a genbook.


Alkitab currently internally handles URI, however it is not exposed to user and does not yet register itself with the OS. We handle URI in the following format:



If the specified path (book) is not in the correct category, the behaviour is unspecified eg:

As we know that Calvin Institute is not a Bible category, it is a General Book category, as for now the behaviour is unspecified (not forced by the API), do as you wish. However, it is recommended to silently ignore by not displaying anything, or show an error/message dialog.

Proposed extension

We (PocketSword) are looking at extending the current situation to allow other applications to open a particular module/verse in our front-end (and, possibly, others?). We're taking the current situation and adding an optional query to the end of the URI. The query is only looked at if the module requested is empty or the module is not installed.

The new format would be:

sword://[optional module]/[ref, module type dependent][optional query]

where the optional query is in the form:

?type=[module type]&module=list


So, if we don't have a module specified OR the specified module isn't installed, then:

I will email sword-devel and open it up for discussion there. --Niccarter 07:38, 14 September 2010 (UTC)

Personal tools