> For the complete documentation index, see [llms.txt](https://spice.docs.medtroniclabs.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://spice.docs.medtroniclabs.org/admin-guide/multi-language-translation.md).

# Multi-Language Translation

SPICE can show the mobile app in more than one language. This page explains what is translated, where each kind of text comes from, and the overall process an implementer follows to add a language. Step-by-step detail is on [Support for multiple languages](https://spice.docs.medtroniclabs.org/admin-guide/multi-language-translation/support-for-multiple-languages.md).

## What is translated today

| Surface                                                                    | Translation support                                       | Where the translated text lives                                          |
| -------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------ |
| Mobile app, fixed interface text (buttons, titles, messages)               | Yes                                                       | Locale-specific string resources packaged with the app                   |
| Mobile app, form content (questions, hints, option labels, error messages) | Yes, one additional language alongside the default        | Inside each form definition, next to the default-language text           |
| Mobile app, reference lists (for example symptoms and other pick-lists)    | Yes                                                       | A translated value stored beside the default value in the reference data |
| Admin portal                                                               | No. The portal is available in the default language only. | Not applicable                                                           |
| Reporting web application                                                  | No. Available in the default language only.               | Not applicable                                                           |

## How the pieces fit together

1. **Language list.** The platform keeps a list of languages, each with a display name, a short code and the app types it applies to. The mobile app downloads this list and shows it in its language chooser. The admin portal uses the same list for the **Language** field on a health facility and the **Culture** field on a user.
2. **Interface text.** The app ships with its fixed text in the default language and in each additional language that the app release includes.
3. **Form and reference content.** Form definitions and reference lists carry a second-language value for each piece of text. The app shows the second-language value when the user's chosen language has translation turned on, and the default text otherwise.
4. **Standard forms in the portal.** The standard Screening, Enrollment and Assessment forms are stored once per language. The portal's language drop-down on those forms selects which language's version you are editing. See [Workflow & Form Configuration](https://spice.docs.medtroniclabs.org/admin-guide/clinical-workflow-customization.md).
5. **User choice.** A user chooses a language in the app. The app asks for confirmation, saves the choice to the server and signs the user out. The new language applies when the user signs in again.

## Adding a language: summary

| Step                                                                 | Who                                         | Needs an app release? |
| -------------------------------------------------------------------- | ------------------------------------------- | --------------------- |
| Register the language in the platform's language list                | Implementer, as part of platform setup      | No                    |
| Provide translated reference-list values                             | Implementer, as part of platform setup      | No                    |
| Provide translated form content for the standard forms               | Administrator in the portal, or implementer | No                    |
| Provide translated interface text and enable the language in the app | App developer                               | Yes                   |
| Assign the language to facilities and users                          | Administrator in the portal                 | No                    |

Details of each step are on [Support for multiple languages](https://spice.docs.medtroniclabs.org/admin-guide/multi-language-translation/support-for-multiple-languages.md).

## Notes

* Reference data is cached by the platform. After you change reference-list translations directly in the data store, clear the cache or restart the affected service so that users receive the new text.
* Users must download fresh configuration to see translated content. That happens when they sign in or switch facility.
* Text typed by users, such as names and notes, is stored as entered and is never translated.

## Related pages

* [Support for multiple languages](https://spice.docs.medtroniclabs.org/admin-guide/multi-language-translation/support-for-multiple-languages.md)
* [Customization Guide](https://spice.docs.medtroniclabs.org/admin-guide/customization-guide.md)
