docs: translating --> internationlization

This commit is contained in:
dannyrb 2019-12-06 22:56:00 -05:00
parent 7a8ae23839
commit 9a71edda6a
2 changed files with 9 additions and 9 deletions

View File

@ -6,7 +6,6 @@
- [Installation](essentials/installation.md)
- [Data Source](essentials/data-source.md)
- [Configuration](essentials/configuration.md)
- [Translating](essentials/translating.md)
- [Contributing](contributing/index.md)
- [Continuous Integration](continous-integration.md)
@ -16,6 +15,7 @@
- [Viewer](viewer/index.md)
- [Configuration](viewer/configuration.md)
- [Themeing](viewer/themeing.md)
- [Internationalization](viewer/internationalization.md)
- [Extensions](extensions/index.md)
- [Registering](extensions/index.md#registering-an-extension)
- [Lifecycle Hooks](extensions/index.md#lifecycle-hooks)

View File

@ -1,4 +1,4 @@
# Translating
# Internationalization
OHIF supports internationalization using [i18next](https://www.i18next.com/)
through the npm package [@ohif/i18n](https://www.npmjs.com/package/@ohif/i18n),
@ -15,7 +15,7 @@ where is the main instance of i18n containing several languages and tools.
</div>
</div>
### Installing
## Installing
```bash
yarn add @ohif/i18n
@ -25,7 +25,7 @@ yarn add @ohif/i18n
npm install --save @ohif/i18n
```
### How it works
## How it works
After installing `@ohif/i18n` npm package, the translation function
[t](https://www.i18next.com/overview/api#t) can be used [with](#with-react) or
@ -57,13 +57,13 @@ If the translation.json file contains a key that matches the HTML content e.g.
---
#### With React
### With React
This section will introduce you to [react-i18next](https://react.i18next.com/)
basics and show how to implement the [t](https://www.i18next.com/overview/api#t)
function easily.
##### Using HOCs
#### Using HOCs
In most cases we used
[High Order Components](https://react.i18next.com/latest/withtranslation-hoc) to
@ -86,13 +86,13 @@ export default withTranslation('MyNameSpace')(MyComponent);
> [I18nextProvider](#using-outside-of-ohif-viewer) section, `withTranslation`
> HOC doesnt works without a I18nextProvider
##### Using Hooks
#### Using Hooks
Also, it's possible to get the `t` tool using
[React Hooks](https://react.i18next.com/latest/usetranslation-hook), but it
requires at least React > 16.8 😉
#### Using outside of OHIF viewer
### Using outside of OHIF viewer
OHIF Viewer already sets a main
[I18nextProvider](https://react.i18next.com/latest/i18nextprovider) connected to
@ -119,7 +119,7 @@ usage.
---
#### Without React
### Without React
When needed, you can also use available translations _without React_.