BCP 47 Updates on the website

[darcywong00]

Reference

https://docs.google.com/document/d/1nQi65m2i9DrAmwG_ahdYtn5JcWYTwI_kJoSLeK2nPAs/edit#heading=h.gql9ftadtdao

TODOs

• KeymanWeb Cloud API 1.0-4.0 documentation need updates. Following are some notable changes from the documentation for versions 2.0-4.0:

• Edit id description on page: https://help.keyman.com/developer/cloud/5.0/obj-language.php.

• Reference the schemas on api.keyman.com.

• Keyman Engine for Windows documentation already refers to BCP-47 codes. However, these are slightly conflated with ethnologuecodes, viz. https://help.keyman.com/developer/engine/desktop/10.0/api/IKeymanKeyboard/DefaultBCP47Languages

• The page https://help.keyman.com/products/desktop/10.0/docs/advanced_locale_edit.php(as well as the two previous versions) have currently broken links to the Online Editor that is supposed to facilitate localization of the UI. Assuming we plan to reinstate that capability in some form or fashion, we need to evaluate what we say about the language code. I’m assuming we could just say BCP-47. Marc fixed links, but BCP 47 TBD

• Check for any other use of 3-letter ISO 639-3 tags across documentation examples.

• Don’t forget to update https://help.keyman.com/developer/language/guide/history.

Keymanweb 10.0 TODOs

• Use of “ISO” and “language” need to be clarified on the 5.0 version of this page: https://help.keyman.com/developer/engine/web/2.0/reference/keyboard_properties

• The definition of “languageCode” needs to be changed on the 5.0 version of this page: https://help.keyman.com/developer/engine/web/2.0/reference/core/setActiveKeyboard

• The three-letter codes in the 5.0 version of these files need to be changed to BCP-47: https://help.keyman.com/developer/engine/web/2.0/guide/examples/js/unified_loader.js

• https://help.keyman.com/developer/engine/web/2.0/guide/examples/js/keymanweb.js

• The references to IS0 639-3 and “three-letter code” need to be changed on the 5.0 versions of these pages: https://help.keyman.com/developer/engine/web/2.0/guide/adding-keyboards (also the examples ”eng” and “heb” need to become “en” and “he” respectively)

• https://help.keyman.com/DEVELOPER/ENGINE/web/2.0/reference/core/addKeyboards

• https://help.keyman.com/DEVELOPER/ENGINE/web/2.0/reference/core/getKeyboard

• https://help.keyman.com/DEVELOPER/ENGINE/web/2.0/reference/core/setActiveKeyboard

• https://help.keyman.com/DEVELOPER/ENGINE/web/2.0/reference/events/kmw.beforekeyboardchange

• https://help.keyman.com/DEVELOPER/ENGINE/web/2.0/reference/events/kmw.keyboardchange

• https://help.keyman.com/DEVELOPER/ENGINE/web/2.0/reference/events/kmw.keyboardregistered

• On the page https://help.keyman.com/DEVELOPER/ENGINE/web/2.0/reference/keyboard_properties, either edit the existing description for KLC (languageCode) to refer to BCP-47, or if a new code is to be defined to live alongside the legacy code, add a new row for it with the appropriate description.

[mcdurdin]

We need to have more detail on the site on how to select an appropriate BCP 47 code, e.g. when to include script or region. The existing content leaves users on their own!

For example: In terms of BCP 47 codes, the script is needed if there is no information on default script in the suppress-script field, mostly for Windows' sake. For a number of languages, we have found this to be the necessary -- it helps the OS to know the rendering rules that it should apply. Otherwise, we don't include script code or country code as a rule.