From 1925aaee47725c1e80c9dc762c76806864b97a5c Mon Sep 17 00:00:00 2001 From: Dan Nesfeder Date: Thu, 3 May 2018 10:50:47 -0700 Subject: [PATCH 1/2] Update localization.md --- localization.md | 64 +++++++++++++++++++++++++++++++++---------------- 1 file changed, 44 insertions(+), 20 deletions(-) diff --git a/localization.md b/localization.md index bd57a77dcbb..5583c2059b8 100644 --- a/localization.md +++ b/localization.md @@ -1,22 +1,46 @@ +## Spoken instructions + +Turn instructions are announced in the user interface language when turn instructions are available in that language. Otherwise, if turn instructions are unavailable in that language, they are announced in English instead. To have instructions announced in a language other than the user interface language, set the `NavigationRoute.Builder#language` property when calculating the route with which to start navigation. + +Turn instructions are primarily designed to be announced by either the Mapbox Voice API (powered by [Amazon Polly](https://docs.aws.amazon.com/polly/latest/dg/SupportedLanguage.html)) or [TextToSpeech](https://developer.android.com/reference/android/speech/tts/TextToSpeech). By default, this SDK uses the Mapbox Voice API, which requires an Internet connection at various points along the route. If the Voice API lacks support for the turn instruction language or there is no Internet connection, TextToSpeech announces the instructions instead. + +By default, distances are given in the predominant measurement system of the system region, which may not necessarily be the same region in which the user is traveling. To override the measurement system used in spoken instructions, set the `MapboxNavigationOptions.Builder#unitType` property when calculating the route with which to start navigation. + +The upcoming road or ramp destination is named according to the local or national language. In some regions, the name may be given in multiple languages. + ## Supported languages -| Language | User interface | Mapbox Voice API | Android TextToSpeech -|------------|:--------------:|:----------------:|:---------------------: -| Catalan | - | — | — -| Chinese | - | ✅ | ✅ -| Danish | - | ✅ | ✅ -| Dutch | - | ✅ | ✅ -| English | ✅ | ✅ | ✅ -| French | - | ✅ | ✅ -| German | - | ✅ | ✅ -| Hebrew | - | - | — -| Hungarian | - | — | ✅ -| Italian | - | ✅ | ✅ -| Portuguese | - | ✅ | ✅ -| Polish | — | ✅ | ✅ -| Romanian | — | ✅ | ✅ -| Russian | - | ✅ | ✅ -| Spanish | - | ✅ | ✅ -| Swedish | - | ✅ | ✅ -| Turkish | — | ✅ | ✅ -| Vietnamese | - | ✅ | ✅ +The table below lists the languages that are supported for user interface elements and for spoken instructions. + +| Language | User interface | [Spoken instructions](https://www.mapbox.com/api-documentation/#instructions-languages) | Remarks +|------------|:--------------:|:-----------------------------:|-------- +| Bengali | ✅ | — +| Chinese | - | ✅ Mandarin | Depends on the device; may require third-party text-to-speech +| Czech | ✅ | - +| Danish | ✅ | ✅ +| French | ✅ | ✅ +| English | ✅ | ✅ +| Esperanto | — | ✅ +| French | ✅ | ✅ +| German | ✅ | ✅ +| Hebrew | ✅ | ✅ | Depends on the device; may require third-party text-to-speech +| Indonesian | — | ✅ | Depends on the device; may require third-party text-to-speech +| Italian | ✅ | ✅ +| Korean | ✅ | — +| Portuguese | ✅ | ✅ +| Polish | — | ✅ +| Romanian | — | ✅ +| Russian | ✅ | ✅ +| Spanish | ✅ | ✅ +| Swedish | ✅ | ✅ +| Turkish | — | ✅ +| Ukrainian | ✅ | ✅ | Depends on the device; may require third-party text-to-speech +| Vietnamese | ✅ | ✅ | Depends on the device; may require third-party text-to-speech + +**Please note:** For languages marked with `Depends on the device; may require third-party text-to-speech`, instructions are provided by the SDK, but we cannot guarantee the given device will have the appropriate `TextToSpeech` speech engine installed to pronounce these instructions correctly. + +## Contributing + +See the [contributing guide](https://github.com/mapbox/mapbox-navigation-ios/blob/master/CONTRIBUTING.md#adding-or-updating-a-localization) for instructions on adding a new localization or improving an existing localization. + +[osrmti]: https://www.mapbox.com/api-documentation/#instructions-languages From 7e538cd8663459213d60560f0dac4cd7dc36326c Mon Sep 17 00:00:00 2001 From: Dan Nesfeder Date: Thu, 3 May 2018 14:42:59 -0700 Subject: [PATCH 2/2] Updates per review --- localization.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/localization.md b/localization.md index 5583c2059b8..393bd8580ad 100644 --- a/localization.md +++ b/localization.md @@ -12,13 +12,12 @@ The upcoming road or ramp destination is named according to the local or nationa The table below lists the languages that are supported for user interface elements and for spoken instructions. -| Language | User interface | [Spoken instructions](https://www.mapbox.com/api-documentation/#instructions-languages) | Remarks +| Language | User interface | [Spoken instructions][apidoc] | Remarks |------------|:--------------:|:-----------------------------:|-------- | Bengali | ✅ | — | Chinese | - | ✅ Mandarin | Depends on the device; may require third-party text-to-speech | Czech | ✅ | - | Danish | ✅ | ✅ -| French | ✅ | ✅ | English | ✅ | ✅ | Esperanto | — | ✅ | French | ✅ | ✅ @@ -43,4 +42,4 @@ The table below lists the languages that are supported for user interface elemen See the [contributing guide](https://github.com/mapbox/mapbox-navigation-ios/blob/master/CONTRIBUTING.md#adding-or-updating-a-localization) for instructions on adding a new localization or improving an existing localization. -[osrmti]: https://www.mapbox.com/api-documentation/#instructions-languages +[apidoc]: https://www.mapbox.com/api-documentation/#instructions-languages