Skip to main content
All CollectionsMobile, Desktop, & Plugins
Contributing Translations for RemNote
Contributing Translations for RemNote

You can create or improve community translations of RemNote through Inlang's web-based editor.

R
Written by RemNote Support
Updated over a year ago

You can help translate RemNote!

Localizing a complex application like RemNote requires a large collective effort. As a startup with only a few employees, creating well-made translations for most of the world’s languages would be impossible. So instead, we chose to enable our community to share their own expertise.

Getting started

  1. Sign in using GitHub. (You need a GitHub account to contribute translations.)

  2. At the top, select the language(s) you wish to translate.

    1. If your language does not exist yet, you can select Add Language at the top-right.

  3. Now you can edit the translations! (Find details below.)

  4. When you're done, you can press the button at the bottom to upload your changes.

    1. From that point on, we'll review your translations and import them, if appropriate.

Editing translations

For each text element within RemNote, you'll find a text box in the editor like this:

You can click into the text field and edit the translation.

⚠️ Important: Do not edit the en (english) translations! We manage these translations ourselves, and your changes will not be approved if you try to edit the English text.

So far, so good. But what is this?

Occasionally you'll encounter these blue placeholders, which RemNote will fill with text, numbers, or entire UI components when it displays the text. You can’t edit the placeholders, but you can change their position to whatever your language's grammar requires.

The placeholder label will give you a clue about what it's being used for. In the above example, the placeholder will receive a count number  – that is, it will say something like “3 Tags” in English when displayed.

You can also look at the translation key for more information about where a string of text is used. For example, SETTINGS.ACCOUNT.ADVANCED_TITLE is a title for the “Advanced” section in the Account section of the settings.

To help speed up the creation of a rough initial translation, you can use the Machine translate button, which appear whenever a text is empty:

Obviously, machine translation will not be perfect and will still require manual editing, especially because the translator is lacking any context about where in the UI these texts are used and what they refer to – but it’s often a useful way to get started, as large chunks of the result will often be reasonably accurate.

Translations are a continual work in progress

As mentioned above, translating an app like RemNote is a large and ambitious project. Most translations will be incomplete for quite some time, and as RemNote changes, new strings of text will be added and old ones will stop being relevant.

Also, we haven't yet made all text in the app available for translation. This is a major effort for our developers, so we’ll be making text translatable slowly over time.

For you as a translator, this means that it’s helpful to come back every few weeks or months and check for any additional text that you can translate.

The review process

Uploading translations will create a so-called Pull Request (“PR”) on our GitHub translation repository. This PR will contain a list of changes to our app's translation files. Before the changes go live within RemNote, a RemNote developer first needs to review the changes and approve them.

It may happen that we have questions or require some kind of change to your PR. So we recommend you watch your GitHub notifications for replies. Depending on your GitHub settings, you’ll usually also get an email when we reply.

You can also help us out by reviewing other people's PRs on the translation repository and suggesting corrections or improvements. You won't be able to approve changes on our behalf, but you can still save us time by doing some of the heavy work.

Testing your changes

You may join our beta program to enable the language setting and test out different languages in RemNote itself.

  • How to change the language setting?

    • In RemNote: Settings > Interface > Global Interface > Language

Note that, in order to see your translations in the app, it can take a couple of weeks after we have approved them in our translation repository.

Did this answer your question?