Scripture Burrito 1.0.0

This is the final release of Scripture Burrito 1.0.0.

Other than the version metadata requirement. It is identical to 1.0.0-rc3.

Scripture Burrito 1.0.0-rc2

rc2 makes one small but significant change: a required property format at the top level of metadata.json that takes the fixed value scripture burrito.

{
  "format": "scripture burrito",
  "meta": {
    "version": "1.0.0-rc2",
    "category": "source",
    ...

This was added to provide an easy way to test whether something (a directory, zip-file, lone JSON file) is a scripture burrito or not.

Assuming no further issues are raised, this release will eventually become 1.0.0.

Scripture Burrito 1.0.0-rc1

After several years of development and testing, we are pleased to announce the availability of Scripture Burrito 1.0-rc1 specification! We recommend that developers of Scripture and Scripture-related applications test and adopt this specification for interchanging data with other systems. Out of the box Scripture Burrito is designed to support the following types of data:

Scripture Text
Scripture Print
Scripture Audio
Scripture Sign Language
Scripture Braille
Scripture Text Stories

As interoperability is our primary goal, we are happy to accept proposals for new flavors based on common interchange scenarios. We have provided instructions and examples for Extending Scripture Burrito by testing and implementing new flavors (using x- flavors). When multiple implementations can be demonstrated, we will consider adding them as official flavors in new schema releases.

If you learn best by example, see the minimal flavor examples.

This work has been a multi-year collaboration between several organizations, including American Bible Society, Clear.Bible, Eldarion, Bridge Connectivity Solutions, SIL, unfoldingWord, United Bible Societies, and the work has been sponsored by illumiNations.

See future development milestones here. The Scripture Burrito Committee invites comments on all aspects of the schema and documentation. Please use Github Issues or Github Discussions to provide feedback.

Scripture Burrito 1.0.0-beta1

• wordAlignment flavor moved to be x-
• bookId clarified

Scripture Burrito 0.3.1

• upgraded ajv and updated schemas to pass strict mode
• copyright is now required in source and template burritos
• burritos not in public domain must declare a rightsHolder
• added versification role #273
• removed canon spec, canon type, and canon constraints #274
• license changes #275

Scripture Burrito 0.3.0

• added example reference format file #158
• removed versification flavour #226
• added localedata role #249
• changed identification format #254
• switched confidentiality to boolean confidential #255

Scripture Burrito 0.3.0-alpha.2

• removed "uploader" metadata
• renamed identifier "server" to "authority"
• renamed "variant" to "category" and changed format for derived
• removed "recipeSpec" and changed to new "recipe" schema #221
• removed need for font type information in typesetScripture

Scripture Burrito 0.2.0-beta.2

Schema Changes

This is a minor release that fixes one schema error found in the meta_version.

Other Notes

We migrated to Github Actions for testing the schema and metadata examples. We also added an NPM package to make the schema easier to use in JavaScript applications.

We are also beginning to provide example Scripture Burrito repositories in the BT Tech Consortium Github organization.

Scripture Burrito 0.2.0-beta

The Scripture Burrito working group is pleased to announce the release of the Scripture Burrito 0.2.0 Beta version of the specification!

The docs for this release are at https://docs.burrito.bible/en/v0.2.0-beta/.

Status

This standard is still a work in progress. Things may well change significantly before v1.0.0. Prototype code implementing SB is encouraged. Here are a couple of proof of concepts that demonstrate Scripture Burrito functionality:

• Scripture Burrito Store–A Javascript implementation of the Scripture Burrito processing model.
• Scripture Burrito RCL–A React Component Library using react-jsonschema-form with the Scripture Burrito Schema

Features

The 0.2.0-beta release is a complete rewrite of the XML based 0.1.0-beta. We are now using JSON-Schema for defining the specification and the only valid expression of the metadata is JSON.

We have included 8 flavors in this release.

This release also includes variants, which are programmaticly derived from source burritos.

Roadmap

The road ahead includes a few high level items that may be of interest:

• More specific information about ingredients, along with several example burritos
• More flavors defined to handle different types of data
• Refinement of the variant and recipe part of the specification.

For more details, see our issue queue in Github.

Feedback

Feedback may be provided here, in this forum, or via the Scripture Burrito Github issues.

The committee invites comments on all aspects of this documentation, but has identified some specific issues about which decisions need to be taken:

JSON only for metadata

The 0.1.0 specification was based on an XML schema for metadata with a JSON representation. However, the goal for 0.2.0 was to switch to JSON Schema as the only representation of the metadata. This transition is now completed and 0.2.0-beta represents this change.

Confidentiality Options

The Confidentiality section includes three options, 1. unrestricted, 2. restricted, 3. private. Please comment on issue #90 if you have a use case which is not covered by this enum.

MD5 Checksums

For ingredient (file) checksums we are using the dated MD5 hashing algorithm. See our discussion about this issue. Please open an issue to let us know if this will be problematic for your use case.

USFM and USX for Scripture Text

The current proposal is based on the Digital Bible Library, which chose USX because it can be validated rigorously. As a result of this choice, several large publishing workflows including YouVersion and API.Bible use USX.

Much of the Bible translation world uses USFM, which is familiar to Bible translators, but which requires bespoke parsing tools, and which can be ambiguous in some circumstances. Also, USX contains machine-readable reference information that cannot be represented in USFM at this time. Valid USFM can be round-tripped to USX. USX cannot be round-tripped to USFM without losing the machine-readable references. Invalid USFM may not have an equivalent representation in USX.

Paratext currently uses both USFM and USX internally at various points.

The committee’s current proposal is

• USFM for translations in progress
• USX for valid content, orientated towards publication (incremental or otherwise)

The committee would appreciate proposals for constructive and technically feasible alternatives.

Acknowledgements

The Scripture Burrito working group would like to express our appreciation to Mark Howe for the exceptional work he has put into developing the current Scripture Burrito 0.2.0 specification.

Scripture Burrito 0.1.0

The Scripture Burrito working group is pleased to announce the release of the Scripture Burrito 0.1.0 version of the specification!

Please note: the 0.1.0 schema was XML based, however, we will be pivoting to JSON Schema as the only representation of the metadata in 0.2.0.

Feedback may be provided via the Technology.Bible forum or via the Scripture Burrito Github issues.

Please also add use cases into the issues queue to help us iterate on the specification.