Files
PortProtonQt/documentation/localization_guide/README.md
Boris Yumankulov cc8c22e972
Some checks failed
Check Translations / check-translations (push) Successful in 47s
Code and build check / Check code (push) Failing after 2m7s
Code and build check / Build with uv (push) Failing after 32s
chore(localization): update
Signed-off-by: Boris Yumankulov <boria138@altlinux.org>
2025-06-10 10:25:42 +05:00

81 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

📘 Эта документация также доступна на [русском.](README.ru.md)
---
## 📋 Contents
- [Overview](#overview)
- [Adding a New Translation](#adding-a-new-translation)
- [Updating Existing Translations](#updating-existing-translations)
- [Compiling Translations](#compiling-translations)
---
## 📖 Overview
Localization in `PortProtonQT` is powered by `Babel` using `.po/.mo` files stored under `LC_MESSAGES/messages.po` for each language.
Current translation status:
<!-- Auto-generated coverage table -->
| Locale | Progress | Translated |
| :----- | -------: | ---------: |
| [de_DE](./de_DE/LC_MESSAGES/messages.po) | 0% | 0 of 160 |
| [es_ES](./es_ES/LC_MESSAGES/messages.po) | 0% | 0 of 160 |
| [ru_RU](./ru_RU/LC_MESSAGES/messages.po) | 100% | 160 of 160 |
---
## 🏁 Adding a New Translation
1. Run:
```bash
uv python install 3.10
uv sync --all-extras --dev
source .venv/bin/activate
python dev-scripts/l10n.py --create-new <locale_code>
```
2. Edit the file `portprotonqt/locales/<locale>/LC_MESSAGES/messages.po` in Poedit or any text editor.
---
## 🔄 Updating Existing Translations
If youve added new strings to the code:
```bash
uv python install 3.10
uv sync --all-extras --dev
source .venv/bin/activate
python dev-scripts/l10n.py --update-all
```
---
## 🧵 Compiling Translations
```bash
uv python install 3.10
uv sync --all-extras --dev
source .venv/bin/activate
python dev-scripts/l10n.py
```
## 🔍 Spell Check
To check spelling, run the following commands:
```bash
uv python install 3.10
uv sync --all-extras --dev
source .venv/bin/activate
python dev-scripts/l10n.py --spellcheck
```
The script performs parallel spellchecking of strings in `.po` and `.pot` files. For each file, it prints the list of strings being checked and highlights any spelling errors with suggestions. Words listed in `dev-scripts/.spellignore` are ignored and not treated as typos.