Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 2.99 KB

README.md

File metadata and controls

62 lines (47 loc) · 2.99 KB

Bible XML Files

Fidei reads bibles in any data dir it has access to. On typical GNU systems (i.e. systems, that follow the XDG spec) this means:

  • User specific data dir: ~/.local/share/arpa.sp1rit.Fidei/
  • System-wide local data dir: /usr/local/share/arpa.sp1rit.Fidei/
  • System-wide package data dir: /usr/share/arpa.sp1rit.Fidei/

however, as Fidei follows the XDG spec, it honors alternative user specific data dirs set by the XDG_DATA_HOME env var, and every alternative directory specified in the XDG_DATA_DIRS env var.

Format

The bible files themselves are in Zefania XML format. While Fidei makes use of some Features within the Format, it also relies more on the location of the specific part within the file, as it does with specific tags; as this allows Fidei to parse, even broken bibles, with relativly small memory usage.

This comes with a few peculiarities, that will need to be respected, in order for Fidei to provide a good expecience with your bible:

  1. The INFORMATION section is required to be at the start before any books.
    While Fidei will read a bible without such a section, the experience will be less than miserable, as Fidei doesn't have any metadata to present to the user.
  2. The language tag within the INFORMATION section is used to find the proper language to match the correct small-caps regex (for proper display of "Lord") against.
    Since the content of the tag will also be passed to ICUs uloc_getDisplayName function, all language tags should follow ISO 639-1, as this is also what Fidei provides for supported languages as default regex already.
  3. Fidei makes use of the bsname attribute of books to store the current state.
    This means, that every bible Fidei reads, should have the same bsname attributes for each of their books. Since this is hard to coordinate, Fidei provides a list of shorthand attributes to be used, aswell as additional information under doc/bibles/BOOKS.md.

Repository

The Fidei project provides a repository with a few biblical translations under it's SourceForge project. It it up to the discretion of the packager, whether to ship them by default, in seperate packages or not at all.

The bibles are available under sourceforge.net/p/fidei/bibles/HEAD/tree/trunk/.

Besides translations, that have entered the public domain by now, the repository also contains encrypted copyright encumbered translations. To decrypt them, you need the 44th Verse of Actus Apostolorum 2 in the Biblia Sacra Vulgata.

openssl enc -in tld.society.book.xml.aes -out tld.society.book.xml -d -aes256 -pass "pass:<passphrase here>" -pbkdf2

Please E-Mail me, if you have any issues with that.


A good source for additional bibles is bible4u.app. But keep in mind that the translations provided by it, might not fully follow the peculiarities of Fidei that are specified above.