Audio Burrito - optional ingredient roles

[gtryus]

The burrito standard lists the roles as optional. I guess our assumption is that both audio and text of Scripture can be ingredients without a roles. Roles would only be needed for timing and other kinds of information.

Notes are particularly complicated in that footnotes were included in a scripture text file and no special role was given when they were included. The question of whether they need a special role if they are recorded remains open.

Also the chapter number might be included in a normal text file but if the chapter number is recorded, one would assume it may need a special role too...

[jsarabia]

A chapter number that is recorded can be labeled with the u23003 timing format. Currently that would need to be prepended to a book, chapter, verse, or verse range though as the scopes for ingredients are not u23003 so I don't think they could say the scope is just the chapter number?

Notes would then need to be handled similarly

[jonathanrobie]

Greg noticed that the examples do not have roles. Is there a default role for a given Burrito flavor? If so, that needs to be documented. The text burrito example seems to assume you can guess the role from the extension, e.g. usfm or usx or lds.

  "ingredients": {
    "release/English.lds": {
      "checksum": {
        "md5": "d18bbee39a1bc150decaac420c7f59da"
      },
      "mimeType": "application/octet-stream",
      "size": 1032
    },
    "release/USX_1/1CH.usx": {
      "checksum": {
        "md5": "136d4d61af63b710d34de856ef1ad6b6"
      },
      "mimeType": "application/xml",
      "size": 176306,
      "scope": {
        "1CH": []
      }
    },

If a file has a .json extension, you have no idea what it is without a role.

[gtryus]

We can use the scope to define the various kinds of audio files. Here are some examples:

• eph 2:0!c would be the scope for the chapter number recording
• eph 2:1!f would be a note recording
• eph 2:1!fk would be for the note title
• eph 2:1!ip would be for introductory material
• eph 2:1!is would be for an introductory note title

[jonathanrobie]

Decision:

For Scripture Audio, role is required for all ingredients. We would like the main Scripture Burrito group to also look at this issue and consider whether role needs to be more clearly defined.

Decision: We need a list of known roles used in audio burritos. Currently, these would all be x- roles but we probably want to agree on some standard ones.