> For the complete documentation index, see [llms.txt](https://docs.rierino.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rierino.com/design/user-interface/translations.md).

# Translations

<figure><img src="/files/amNRIpdLkl2f68DSweOB" alt=""><figcaption><p>Translation UI</p></figcaption></figure>

Translations can be defined with the following configurations:

* **ID:** Unique identifier for the translation [domain ](#user-content-fn-1)[^1]\(e.g. common, product)
* **Entries:** List of translations for the given domain
  * **Key:** Unique identifier for the translation key (e.g. save)
  * **\[locale]:** Matching translation for a specific locale (e.g. key=save, enUS=Save)&#x20;

## Error Messages

A special translation entry with id "error" is used for mapping errors received in API responses to rich content displayed on the user interface.

If the received error includes an error code in response such as standard Rierino [error codes](/troubleshooting/error-codes.md), a translation entry with "CODE\_\[CODE]" key allows display of given message in error pop-ups. If no such entry is found, "message" field in error response is used as the message to display (which can refer to a dictionary entry as well).&#x20;

In both cases, the final message is also allowed to use Handlebars templates, for populating custom Markdown formatted error messages using "detail" field in error response, such as:

```markdown
**Validation Errors:**
{{#each errors}}
* {{getText title}}: {{getText message}}
{{/each}}
```

{% hint style="info" %}
A special "getText" helper is available on these templates, allowing localization of data labels for current user language.
{% endhint %}

[^1]: Used for referring to individual entries as a prefix. For example a {{common.save}} entry refers to "save" key of "common" translation domain.

    When the prefix is ignored, such as {{save}}, always the "common" domain is used.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.rierino.com/design/user-interface/translations.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.