5.4 KiB
Intro
Thanks for your interest in improving our translations! This document provides details on how to contribute to a translation. This document assumes you can run commandline tools, know how to switch languages within Logseq and basic Clojurescript familiarity. We use tongue, a most excellent library, for our translations.
Setup
In order to run the commands in this doc, you will need to install Babashka.
Where to Contribute
Language translations are in two files, src/main/frontend/dicts.cljc and src/main/frontend/modules/shortcut/dicts.cljc.
Language Overview
First, let's get an overview of Logseq's languages and how many translations your language has compared to others:
$ bb lang:list
| :locale | :percent-translated | :translation-count | :language |
|----------+---------------------+--------------------+------------------------|
| :es | 100 | 492 | Español |
| :tr | 100 | 492 | Türkçe |
| :en | 100 | 492 | English |
| :uk | 95 | 466 | Українська |
| :ru | 95 | 466 | Русский |
| :ko | 93 | 459 | 한국어 |
| :de | 93 | 459 | Deutsch |
| :fr | 92 | 453 | Français |
| :pt-PT | 92 | 453 | Português (Europeu) |
| :pt-BR | 92 | 451 | Português (Brasileiro) |
| :sk | 90 | 445 | Slovenčina |
| :zh-CN | 90 | 441 | 简体中文 |
| :nb-NO | 75 | 370 | Norsk (bokmål) |
| :ja | 75 | 368 | 日本語 |
| :pl | 72 | 353 | Polski |
| :nl | 72 | 353 | Dutch (Nederlands) |
| :zh-Hant | 71 | 349 | 繁體中文 |
| :it | 71 | 349 | Italiano |
| :af | 22 | 106 | Afrikaans |
Total: 19
Let's try to get your language translated as close to 100% as you can!
Edit a Language
To see what translations are missing for your language use:
$ bb lang:missing LOCALE
| :translation-key | :string-to-translate | :file |
|---------------------------------------------+---------------------------------------------+---------------------|
| :content/copy-block-url | Copy block URL | frontend/dicts.cljs |
| :content/copy-export-as | Copy / Export as.. | frontend/dicts.cljs |
| :content/copy-ref | Copy this reference | frontend/dicts.cljs |
| :content/delete-ref | Delete this reference | frontend/dicts.cljs |
...
Now, manually, add keys for your language to the translation files, save and rerun the above command. Over time you're aiming to have this list drop to zero. Since this process can be tedious, there is an option to print the untranslated strings to copy and paste them to the files:
# When pasting this content, be sure to update the indentation to match the file
$ bb lang:missing LOCALE --copy
;; For frontend/dicts.cljs
:content/copy-block-url "Copy block URL"
:content/copy-export-as "Copy / Export as.."
:content/copy-ref "Copy this reference"
:content/delete-ref "Delete this reference"
...
Almost all translations are pretty quick. The only exceptions to this are the keys :tutorial/text and :tutorial/dummy-notes. These reference files that are part of the onboarding tutorial. Most languages don't have this translated. If you are willing to do this, we would be happy to have this translated.
Fix Untranslated
There is a lot to translate and sometimes we forget to translate a string. To see what translation keys are still left for your language use :
$ bb lang:duplicates LOCALE
Keys with duplicate values found:
| :translation-key | :duplicate-value |
|-----------------------------------+------------------|
| :general | General |
| :logseq | Logseq |
| :no | No |
Fix Mistakes
Sometimes, we typo a translation key or forget to use it. If this happens,
the github CI step of bb lang:validate-translations will detect these errors
and tell you what's wrong.
Add a Language
To add a new language, add an entry to frontend.dicts/languages. Then add a
new locale keyword to frontend.dicts/dicts and to
frontend.modules.shortcut.dicts/dicts and start translating as described above.