Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Determine format for Resources #29

Open
markboots opened this issue Sep 22, 2017 · 0 comments
Open

Determine format for Resources #29

markboots opened this issue Sep 22, 2017 · 0 comments

Comments

@markboots
Copy link
Contributor

We need to decide on the format used for Resources, which are set of localized strings or audio(media) resources.

An example draft to start:

A Resource describes a collection of localized strings or media resources, used when content needs to be presented to Contacts in multiple languages. Resources have the following following structure:

[resource-uuid]:{
  "id":[resource-uuid],
  "text":{
    [iso-639-3 language code]:[localized text],
    [iso-639-3 language code]:[localized text],
    ...
    [iso-639-3 language code]:[localized text],
  },
  "audio":{
    [iso-639-3 language code]:[media ID],
    [iso-639-3 language code]:[media ID],
    ...
    [iso-639-3 language code]:[media ID],
  }
}

for instance,

"6681c54c-9fcd-11e7-abc4-cec278b6b50a":{
  "id":"6681c54c-9fcd-11e7-abc4-cec278b6b50a"
  "text":{
    "eng":"How are you?",
    "aka":"Wo ho te sɛn?",
    "dag":"A mal’ alaafee?"
  },
  "audio":{
    "eng":"5718eb16.wav",
    "aka":"5f6e4694.wav",
    "dag":"68bd67f2.wav"
  }
}

Questions:

  • Do we need to support media resources other than audio? e.g. localized video, for smartphone channels?
  • Is it valuable to have the key also inside the resource body, not just in the external key?
  • Should we list the languages separately at the top level?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant