Merge pull request #305 from bible-technology/develop

merge rc3 changes
bible-technology · Apr 18, 2023 · df042f8 · df042f8
2 parents d748b6c + 9280fbb
commit df042f8
Show file tree

Hide file tree

Showing 19 changed files with 38 additions and 18 deletions.
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -0,0 +1,14 @@
+James Tauber <jtauber@jtauber.com> Eldarion, Clear.Bible
+Jonathan Robie <jonathan.robie@gmail.com> SIL, Clear.Bible
+Jesse Griffin <jag3773@gmail.com> unfoldingWord
+Joel Mathew <mail@joelmath.io> Bridge Connectivity Solutions
+Tim Steenwyk <tim_steenwyk@sil.org> SIL
+Eric Pyle <eric_pyle@sil.org> SIL
+Benjamin Varghese <benjamin_varghese@nlife.in> NLCI
+Mark Howe <mvahowe@gmail.com> United Bible Societies, MVH Solutions
+Sean Morrison <morriss@me.com> United Bible Societies
+Dan de Blois <rddeblois@gmail.com> United Bible Societies
+James Cuénod <j3frea@gmail.com> 
+Katherine Jensen <katherinejensen00@gmail.com>
+Han Chung <hchung@americanbible.org> American Bible Society
+Andi Wu <andi.wu@cherithanalytics.com> Clear.Bible
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 BT Tech Consortium
+Copyright (c) 2020-2023 Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/conf.py b/docs/conf.py
@@ -59,7 +59,7 @@
 # The short X.Y version.
 version = u'1.0.0'
 # The full version, including alpha/beta/rc tags.
-release = u'1.0.0-rc2'
+release = u'1.0.0-rc3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/examples/artifacts/audioTranslation.json b/docs/examples/artifacts/audioTranslation.json
@@ -1,7 +1,7 @@
 {
   "format": "scripture burrito",
   "meta": {
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "category": "source",
     "generator": {
       "softwareName": "DBLImport",

diff --git a/docs/examples/artifacts/embossedBrailleScripture.json b/docs/examples/artifacts/embossedBrailleScripture.json
@@ -1,7 +1,7 @@
 {
   "format": "scripture burrito",
   "meta": {
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "category": "source",
     "generator": {
       "softwareName": "DBLImport",

diff --git a/docs/examples/artifacts/minimalTemplate.json b/docs/examples/artifacts/minimalTemplate.json
@@ -1,7 +1,7 @@
 {
   "format": "scripture burrito",
   "meta": {
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "category": "template",
     "templateName": {
       "en": "A Minimal and Frankly Pointless Template"

diff --git a/docs/examples/artifacts/signLanguageVideoTranslation.json b/docs/examples/artifacts/signLanguageVideoTranslation.json
@@ -1,7 +1,7 @@
 {
   "format": "scripture burrito",
   "meta": {
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "category": "source",
     "generator": {
       "softwareName": "DBLImport",

diff --git a/docs/examples/artifacts/textStories.json b/docs/examples/artifacts/textStories.json
@@ -2,7 +2,7 @@
   "format": "scripture burrito",
   "meta": {
     "category": "source",
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "dateCreated": "2020-03-31T09:04:10.3+02:00",
     "generator": {
       "softwareName": "SB01Import",

diff --git a/docs/examples/artifacts/textTranslation.json b/docs/examples/artifacts/textTranslation.json
@@ -1,7 +1,7 @@
 {
   "format": "scripture burrito",
   "meta": {
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "category": "source",
     "generator": {
       "softwareName": "DBLImport",

diff --git a/docs/examples/artifacts/textTranslation_derived.json b/docs/examples/artifacts/textTranslation_derived.json
@@ -1,7 +1,7 @@
 {
   "format": "scripture burrito",
   "meta": {
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "category": "derived",
     "dateCreated": "2019-02-19T01:02:03+01:00",
     "generator": {

diff --git a/docs/examples/artifacts/typesetScripture.json b/docs/examples/artifacts/typesetScripture.json
@@ -1,7 +1,7 @@
 {
   "format": "scripture burrito",
   "meta": {
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "category": "source",
     "generator": {
       "softwareName": "DBLImport",

diff --git a/docs/examples/artifacts/wordAlignment.json b/docs/examples/artifacts/wordAlignment.json
@@ -2,7 +2,7 @@
   "format": "scripture burrito",
   "meta": {
     "category": "source",
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "dateCreated": "2020-03-31T09:04:10.3+02:00",
     "generator": {
       "softwareName": "Autographa-Aligner 0.1.0",

diff --git a/docs/examples/artifacts/xScripture.json b/docs/examples/artifacts/xScripture.json
@@ -2,7 +2,7 @@
   "format": "scripture burrito",
   "meta": {
     "category": "source",
-    "version": "1.0.0-rc2",
+    "version": "1.0.0-rc3",
     "dateCreated": "2020-03-31T09:04:10.3+02:00",
     "generator": {
       "softwareName": "SB01Import",

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,7 +6,7 @@ Scripture Burrito Documentation
 
 .. image:: ../logo/burrito_logo.png
 
-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:
+After several years of development and testing, we are pleased to announce the availability of **Scripture Burrito 1.0-rc3** 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:
 
 - :ref:`scripture_text_flavor`
 - :ref:`scripture_print_flavor`

diff --git a/docs/schema_docs/design.rst b/docs/schema_docs/design.rst
@@ -33,7 +33,12 @@ These flavorTypes are then subclassed into various flavors, as illustrated:
 Metadata Filename
 =================
 
-A Scripture Burrito can exist in multiple data formats. By convention, when the metdata is written to disk it should be in a file with the name of ``metadata.json`` at the **root** level of the Burrito.
+A Scripture Burrito can exist in multiple data formats. When the metadata is written to disk it must be in a file with the name of ``metadata.json`` at the **root** level of the Burrito.
+
+Other Burrito Files
+===================
+
+By convention, all files should be in the same directory as `metadata.json` or sub directories thereof. An acceptable exception is large media files that you may not want to distribute with the burrito itself, in which case a URL is acceptable. A burrito is intended to be a snapshot so maintaining external resources is beyond the scope of this specification. If files are references via URL, a client's expectation would be to get the same data each time it hits the provided URL.
 
 File Encoding
 =============

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "scripture-burrito",
-  "version": "1.0.0-rc2",
+  "version": "1.0.0-rc3",
   "description": "Schema support for Scripture Burrito",
   "main": "schema/index.js",
   "directories": {

diff --git a/schema/meta_version.schema.json b/schema/meta_version.schema.json
@@ -4,6 +4,6 @@
     "$$target": "meta_version.schema.json",
     "title": "Meta Version",
     "type": "string",
-    "enum": ["1.0.0-rc2"],
+    "enum": ["1.0.0-rc3"],
     "description": "Version of the Scripture Burrito specification this file follows."
 }
diff --git a/schema/recipe.schema.json b/schema/recipe.schema.json
@@ -20,5 +20,6 @@
         },
         "required": ["idAuthority", "operation", "data"],
         "additionalProperties": false
-    }
+    },
+    "minItems": 1
 }
diff --git a/schema/type.schema.json b/schema/type.schema.json
@@ -67,7 +67,7 @@
                         "$ref": "scope.schema.json"
                     }
                 },
-                "required": ["flavor", "currentScope"],
+                "required": ["name", "flavor", "currentScope"],
                 "additionalProperties": false
             }
         },