Skip to content
Snippets Groups Projects
Unverified Commit 8c17699a authored by github-automation-metabase's avatar github-automation-metabase Committed by GitHub
Browse files

docs - locale params (#51001) (#51116)


* locale params

* formatting

* note on UI vs content

* interactive embedding

* language update

* plans blockquote

* asterisk

Co-authored-by: default avatarJeff Bruemmer <jeff.bruemmer@gmail.com>
parent 63833f46
No related branches found
No related tags found
No related merge requests found
......@@ -16,37 +16,47 @@ Here you can set the default language (also called the "instance language") acro
Thanks to our amazing user community, Metabase has been translated into many different languages. Due to [the way we collect translations](#translations), languages may be added or removed during major releases depending on translation coverage.
The languages you can currently pick from are:
- English (default)
- Albanian
- Arabic
- Bulgarian
- Catalan
- Chinese (simplified)
- Chinese (traditional)
- Czech
- Dutch
- Farsi/Persian
- Finnish
- French
- German
- Indonesian
- Italian
- Japanese
- Korean
- Latvian
- Norwegian Bokmål
- Polish
- Portuguese
- Russian
- Serbian
- Slovak
- Spanish
- Swedish
- Turkish
- Ukrainian
- Vietnamese
Supported languages include:
| Language | Code |
| ---------------------- | ------- |
| English | `en` |
| Albanian | `sq` |
| Arabic | `ar` |
| Arabic (Saudi Arabia) | `ar-SA` |
| Bulgarian | `bg` |
| Catalan | `ca` |
| Chinese (Traditional) | `zh` |
| Chinese (Taiwanese) | `zh-TW` |
| Chinese (Hong Kong) | `zh-HK` |
| Chinese (Simplified) | `zh-CN` |
| Czech | `cs` |
| Dutch | `nl` |
| Farsi/Persian | `fa` |
| Finnish | `fi` |
| French | `fr` |
| German | `de` |
| Hebrew | `he` |
| Hungarian | `hu` |
| Indonesian | `id` |
| Malay | `ms` |
| Italian | `it` |
| Japanese | `ja` |
| Korean | `ko` |
| Latvian | `lv` |
| Norwegian Bokmål | `nb` |
| Polish | `pl` |
| Portuguese (Brazilian) | `pt-BR` |
| Russian | `ru` |
| Serbian | `sr` |
| Slovak | `sk` |
| Spanish | `es` |
| Swedish | `sv` |
| Turkish | `tr` |
| Ukrainian | `uk` |
| Vietnamese | `vi` |
The locale codes are relevant for setting the language in [static embeds](../embedding/static-embedding-parameters.md#setting-the-language-for-a-static-embed).
> While Metabase can support languages that read right to left, the Metabase UI is designed around languages that read left to right.
......
......@@ -275,13 +275,13 @@ To hide a question or dashboard's title, [additional info](#additional_info), an
### `locale`
You can localize the user interface via a parameter. For example, to set the locale to Spanish:
You can change the language of the user interface via a parameter. For example, to set the locale to Spanish:
```
locale=es-ES
locale=es
```
Check out the [locales Metabase supports](https://github.com/metabase/metabase/tree/master/locales). And read more about [localization](../configuring-metabase/localization.md).
Read more about [localization](../configuring-metabase/localization.md).
### `logo`
......
......@@ -172,7 +172,7 @@ Because Metabase doesn't display locked parameters as filter widgets, you can us
![Look and feel: appearance settings on static embed](./images/04-preview.png)
You can change the appearance of an embedded item by adding hash parameters to the end of the URL in your iframe's `src` attribute.
You can change the appearance of an embedded item by adding hash parameters (e.g., `#theme=night`) to the end of the URL in your iframe's `src` attribute.
For example, the following embedding URL will display an embedded item in dark mode, without a border, and with its original title:
......@@ -186,6 +186,7 @@ You can preview appearance settings from your question or dashboard's embedded a
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `background` | true (default), false. Dashboards only. |
| `bordered` | true (default), false. |
| `locale\*` | E.g., `locale=ko`. See [list of locales](../configuring-metabase/localization.md#supported-languages) |
| `titled` | true (default), false. |
| `theme` | null (default), night. `theme=transparent` should work, but is deprecated (see [Transparent backgrounds](#transparent-backgrounds-for-embeds)) |
| `refresh` (dashboard only) | integer (seconds, e.g., `refresh=60`). |
......@@ -198,6 +199,24 @@ You can preview appearance settings from your question or dashboard's embedded a
For global appearance settings, such as the colors and fonts used across your entire Metabase instance, see [Customizing Metabase's appearance](../configuring-metabase/appearance.md).
## Setting the language for a static embed
{% include plans-blockquote.html feature="Locales for static embeds" %}
To change the UI language for a static embed, you can set its [locale](../configuring-metabase/localization.md#supported-languages). For example, to set a public link's language to Korean, you could append `#locale=ko`.
```
https://metabase.example.com/public/dashboard/7b6e347b-6928-4aff-a56f-6cfa5b718c6b?category=&city=&state=#locale=ko
```
If you have multiple params, separated them with an ampersand `&`:
```
category=Gadget&state=Vermont#theme=night&locale=ko
```
The `locale` param only changes the language for Metabase UI elements. The _content_'s language is defined by whomever created the item. So for example Metabase wouldn't translate the name of a question, but Metabase _would_ translate the UI text "Export to PDF".
## Transparent backgrounds for embeds
Making an embed transparent depends on the type of embed:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment