From 057f5e9bc285a35db5803c70abf2ff60c838a3a3 Mon Sep 17 00:00:00 2001 From: Jonathan Robie Date: Tue, 1 Nov 2022 11:26:31 -0400 Subject: [PATCH 1/8] Update design.rst --- docs/schema_docs/design.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/schema_docs/design.rst b/docs/schema_docs/design.rst index 8c80bb6..6a6fba3 100644 --- a/docs/schema_docs/design.rst +++ b/docs/schema_docs/design.rst @@ -33,7 +33,7 @@ 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. By convention, when the metadata is written to disk it should be in a file with the name of ``metadata.json`` at the **root** level of the Burrito. File Encoding ============= From ae731d1e3666efb2245f7a2337d1863ed17385e5 Mon Sep 17 00:00:00 2001 From: James Tauber Date: Tue, 10 Jan 2023 09:27:11 -0500 Subject: [PATCH 2/8] clarified metadata.json and file locations per #252 --- docs/schema_docs/design.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/schema_docs/design.rst b/docs/schema_docs/design.rst index 6a6fba3..15b5329 100644 --- 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 metadata 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 ============= From 2cf6cd6729382b68629eca228a6e66deff860f7f Mon Sep 17 00:00:00 2001 From: James Tauber Date: Tue, 21 Feb 2023 07:01:41 -0500 Subject: [PATCH 3/8] updated license --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 5e4eb20..b575b9b 100644 --- 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 From 983a37598924816308c8c529e639c9a147585aa8 Mon Sep 17 00:00:00 2001 From: James Tauber Date: Tue, 7 Mar 2023 07:54:53 -0500 Subject: [PATCH 4/8] initial CONTRIBUTORS file --- CONTRIBUTORS | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 CONTRIBUTORS diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 0000000..71363dd --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1,14 @@ +James Tauber Eldarion, Clear.Bible +Jonathan Robie SIL, Clear.Bible +Jesse Griffin unfoldingWord +Joel Mathew Bridge Connectivity Solutions +Tim Steenwyk SIL +Eric Pyle SIL +Benjamin Varghese NLCI +Mark Howe United Bible Societies, MVH Solutions +Sean Morrison United Bible Societies +Dan de Blois United Bible Societies +James Cuénod +Katherine Jensen +Han Chung American Bible Society +Andi Wu Clear.Bible From bc56fc22d69ab1db3a26b57f06d7878fe0cdfa0a Mon Sep 17 00:00:00 2001 From: James Tauber Date: Tue, 7 Mar 2023 09:04:29 -0500 Subject: [PATCH 5/8] updated docs homepage to say rc2 --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index cf445f8..eaa5f99 100644 --- 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-rc2** 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` From 0f63fce5811a8bbf6f04e4c3c1ffd331faaa7aff Mon Sep 17 00:00:00 2001 From: James Tauber Date: Tue, 21 Mar 2023 08:21:37 -0400 Subject: [PATCH 6/8] require name on scripture flavourType --- schema/type.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/type.schema.json b/schema/type.schema.json index bd2d995..9d0efc5 100644 --- 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 } }, From c0a1ace02f8b9bc756199bcd16aa322ea3f54002 Mon Sep 17 00:00:00 2001 From: James Tauber Date: Tue, 21 Mar 2023 08:29:35 -0400 Subject: [PATCH 7/8] recipe must have at least one item --- schema/recipe.schema.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/schema/recipe.schema.json b/schema/recipe.schema.json index 143136e..6fd0121 100644 --- a/schema/recipe.schema.json +++ b/schema/recipe.schema.json @@ -20,5 +20,6 @@ }, "required": ["idAuthority", "operation", "data"], "additionalProperties": false - } + }, + "minItems": 1 } From 7ee5a3dbedb69330979b3c75a8d2afd20d5cef26 Mon Sep 17 00:00:00 2001 From: James Tauber Date: Tue, 4 Apr 2023 01:22:41 -0400 Subject: [PATCH 8/8] bump to rc3 --- docs/conf.py | 2 +- docs/examples/artifacts/audioTranslation.json | 2 +- docs/examples/artifacts/embossedBrailleScripture.json | 2 +- docs/examples/artifacts/minimalTemplate.json | 2 +- docs/examples/artifacts/signLanguageVideoTranslation.json | 2 +- docs/examples/artifacts/textStories.json | 2 +- docs/examples/artifacts/textTranslation.json | 2 +- docs/examples/artifacts/textTranslation_derived.json | 2 +- docs/examples/artifacts/typesetScripture.json | 2 +- docs/examples/artifacts/wordAlignment.json | 2 +- docs/examples/artifacts/xScripture.json | 2 +- docs/index.rst | 2 +- package.json | 2 +- schema/meta_version.schema.json | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f86eba9..768abc7 100644 --- 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 index 5b0e5f3..b46e3b3 100644 --- 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 index 4360450..a4b19db 100644 --- 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 index 35f35f7..f7f8897 100644 --- 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 index 857aed2..b3e6190 100644 --- 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 index 74f2e37..5a83792 100644 --- 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 index ed8e44c..5f6e43b 100644 --- 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 index 4325758..a1e5edc 100644 --- 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 index b602a71..2a60c48 100644 --- 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 index 46b1c69..b8fcd21 100644 --- 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 index 9613aa3..7d81911 100644 --- 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 index eaa5f99..11543c1 100644 --- 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-rc2** 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/package.json b/package.json index 878a3d5..39e55b9 100644 --- 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 index 588f2e2..5eb13b4 100644 --- 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." }