Skip to content

TRANSLATORS.md

Latest commit

 

History

History
136 lines (104 loc) · 4.12 KB

TRANSLATORS.md

File metadata and controls

136 lines (104 loc) · 4.12 KB

Instructions for Translators

Thank you for your interest in translating Bazaar! 🏷️🗺️💜

Some basic rules:

  • You must be fluent in the language you contribute
  • You may not use llms to generate the strings (I could do that). If you do, I will ban you from the project
  • If you are editing existing translation, make sure to check rules for that language in TRANSLATORS-[language code].md file.

Basic Process

Fork the project (so you can open a PR later) and clone the repo. Then make sure your current directory is the bazaar project root:

# Replace '...' with the URL of your Bazaar fork
# for which you have write permissions
git clone ...
cd bazaar

Automatic Setup

Once you've done that, you can run ./translators.sh and follow instructions present on the screen. The script will show you what po/LINGUAS currently looks like. If everything is correct, type Y and press enter. After that the script will ask you to enter language code, please enter it, and press enter. The script will now generate a new po file or update an existing one such that any new translatable strings will be available.

You are now ready to open your po file in your text editor or translation editor (POEdit, GTranslator, Lokalize, etc.) and begin translating. When you are done, commit your changes and submit a pull request on github.

Manual Setup

Once you've done that, setup the project with meson with the im_a_translator flag set to true:

meson setup build -Dim_a_translator=true

Add your language identifier to po/LINGUAS. For example, if you are adding a Spanish translation, insert es into the newline-separated list, keeping it sorted alphabetically. So if the po/LINGUAS file currently looks like this:

# Please keep this file sorted alphabetically.
ab
en_GB
ms

you will edit the file to look like this:

# Please keep this file sorted alphabetically.
ab
en_GB
es
ms

Next, enter the build directory:

cd build

Run this command to generate the main pot (Portable Object Template) file:

meson compile bazaar-pot

You might get a bunch of output complaining that the blp extension is unknown. You can ignore this.

Finally, still inside the build directory, run the following command to update and/or create the po (Portable Object) files:

meson compile bazaar-update-po

You are now ready to open your po file in your text editor or translation editor (POEdit, GTranslator, Lokalize, etc.)and begin translating. When you are done, commit your changes and submit a pull request on GitHub. Make sure to only commit files that are related to your translation.

Update existing translations

Generate a fresh .pot file again (if necessary) with the commands from above.

msgmerge --update --verbose po/de.po po/bazaar.pot

Please make the previous update step a separate commit in your PR so it is easier to review. Thanks!

Test your translations

Replace "de" with your Language code!

msgfmt po/de.po -o bazaar.mo

Copy the .mo file so Bazaar can see it

sudo cp bazaar.mo /var/lib/flatpak/runtime/io.github.kolunmi.Bazaar.Locale/x86_64/stable/active/files/de/share/de/LC_MESSAGES/

Make sure to kill the background process from Bazaar first so the desired changes/language will be used.

killall bazaar

Override the used Language and launch Bazaar

LANGUAGE=de flatpak run io.github.kolunmi.Bazaar

Notes From Translators

Both automatic and manual processes may generate entries marked as fuzzy. This means that for such entries, gettext attempted to derive previously existing translation. Some translation suites, like Lokalize, will utilize this marking to set strings as unreviewed and remove when the entry is marked finished. When working with pot-files using text editor, be sure to remove fuzzy marks yourself from entries you deem finished, else your translation will not appear in Bazaar.