Internationalization: Support localizing Scripture References

[tjcouch-sil]

User Story

As a translator into a language that uses various Scripture Reference layouts, I want Platform.Bible to support localizing Scripture References how my project specifies so that I can publish my project with the appropriate format of references that readers will understand.

Description

Depends on #735

We need to support localizing Scripture references into reader-friendly format for final publishing and such:

• [ ] Create a utility class in platform-bible-utils's internationalization stuff for localizing Scripture References based on the VerseRef capabilities in the localization service.
  • [ ] It should have a function that accepts something like a reference, locale, and options and return a properly formatted reference
  • Will this also need to accept a mapping of book names or something? Probably...?
• [ ] Set up something on the localization service that accepts a project id and a reference and spits out the appropriately localized reference
  • There are project settings available from Paratext that indicate how to localize Scripture references. Use these. See Paratext "Scripture Reference Settings" dialog and settings in Settings.xml
  • Note: It appears that Paratext has different defaults for these project settings based on something (probably locale). We should probably follow along

Paratext's Scripture Reference Settings dialog for a Hawaiian Pidgin test project:

Paratext's Scripture Reference Settings dialog for a Syriac test project:

Internationalization Spec

[irahopkinson]

Maybe I'm misunderstanding but it seems like a bad idea to localize a Scripture reference. References should be absolute and unique and not dependent on the users UI language. Sure localize what the user sees but don't localize a reference.

[tjcouch-sil]

Agreed; this is just for the reader-facing locale-based reference. I'm talking about (for example; I don't know where else it's used) the reformatted reference that gets put onto the exported USX for cross references and such in the project's native reference format. I don't know what to call that, though. I will adjust the user story and add a screenshot of the dialog in hopes that it may also clarify.

Let me know if you have other thoughts or concerns.