Scripture Burrito Documentation¶
This is the official documentation for the evolving Scripture Burrito standard. See the development milestones here).
This is 0.3.1 based on JSON Schema.
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.2 represents this change.
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.
- Schema Documentation
- Overall Design
- Common Definitions
- Copyright and License Information
- Meta (Derived)
- Metadata (Derived)
- Flavor Details: Glossed Text Stories
- Meta Comments
- Meta Date created
- Meta Default Language
- Meta Version
- Numbering System
- Flavor Details: Parascriptural Word Alignment
- Promotional Statements
- Recipe Element
- Recipe Section
- Flavor Details: Audio Translation
- Flavor Details: Scripture: Braille Publication
- Flavor Details: Scripture: Sign Language Video Translation
- Flavor Details: scripture/textTranslation
- Flavor Details: Scripture: Print Publication
- Scripture Flavor Type
- Software and User Info
- Meta (Source)
- Metadata (Default)
- Target Area
- Target Areas
- Meta (Template)
- Metadata (Template)
- UNM49 enum
- Flavor Details: X-Flavor
- Scripture Flavors
- Scripture Text
- Scripture Audio
- Scripture Sign Language
- Scripture Print
- Scripture Braille
- Gloss Flavors
- Parascriptural Flavors
- Peripheral Flavors
- Extending Scripture Burrito
- Scripture Flavors