forgejo/options/locale_readme.md
0ko eb3feaad45
Some checks are pending
/ release (push) Waiting to run
testing / backend-checks (push) Has been skipped
testing / frontend-checks (push) Has been skipped
testing / test-unit (push) Has been skipped
testing / test-e2e (push) Has been skipped
testing / test-mysql (push) Has been skipped
testing / test-pgsql (push) Has been skipped
testing / test-sqlite (push) Has been skipped
testing / test-remote-cacher (redis) (push) Has been skipped
testing / test-remote-cacher (valkey) (push) Has been skipped
testing / test-remote-cacher (garnet) (push) Has been skipped
testing / test-remote-cacher (redict) (push) Has been skipped
testing / security-check (push) Has been skipped
chore(i18n): update contributing documentation with JSON format (#7499)
Things have changed and the readme file in `locale` became significantly less relevant, suggesting things like
> When you work on Forgejo features, you should only modify `locale_en-US.ini`.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7499
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: 0ko <0ko@noreply.codeberg.org>
Co-committed-by: 0ko <0ko@noreply.codeberg.org>
2025-04-10 10:30:22 +00:00

2.4 KiB

Forgejo translations

All translations are stored in directories locale and locale_next.

locale is a historical directory that contains translations in INI format. Forgejo inherited it from Gitea, and Gitea inherited it from Gogs.

Because the INI format had many issues and prevented good translatability, in early 2025 Forgejo started switching to a new format - go-i18n+json.

Working on base language

Here are some tips:

  • when working on non-i18n changes, only change en-US files
    • non-base files are normally modified through Weblate. We appreciate the intention to provide localization for the change you're working on, however, modifying those files leads to merge conflicts with Weblate that aren't easy to resolve. Learn about translating Forgejo.
  • when new strings are added, it's preferred that they're added to locale_en-US.json
  • when strings are modified in locale_en-US.ini, it's preferred that they stay here because moving them around is complicated
  • make sure to remove strings if your change renders them unused
  • consult https://forgejo.org/docs/next/contributor/localization-english/

JSON translations

It is preferred that all new strings added to Forgejo UI are added to the JSON translations instead of INI.

Even though Forgejo parser supports nested sections, linters and Weblate do not. Because of this, most strings need to have all sections flattened into their keys like so:

"some.nested.section.key": "UI text"

However, plural variations of a string, if it has any, are stored in a nested dictionary:

"some.nested.section.key": {
    "one": "%d comment",
    "other": "%d comments"
}

Important

Please avoid adding unnecessary sections to the keys. Sections like repo are vague and represent a large part of the codebase. Keep the sections scoped to where or how the strings are really used, like user_settings or error.

Tip

Due to the flat sections, you can easily find both JSON strings and their usages in the codebase by grepping an entire key.

Tip

3rd party software can determine whether string has plural variations or not from type of it's value in en-US.json.

Working on other languages

Translations are done on Codeberg Translate and not via individual pull requests.