Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve devdocs for localization #11356

Merged
merged 3 commits into from
Jun 4, 2024
Merged

Improve devdocs for localization #11356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cffd25
Improve devdocs for localization
koppor Jun 4, 2024
08af3a2
Fixup
koppor Jun 4, 2024
c5d43e0
Add file hint
koppor Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/code-howtos/localization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,17 @@ The actual usage might look like:
Localization.menuTitle("Used for Menus only");
```

General hints:
## General hints

* Use the String you want to localize directly, do not use members or local variables: `Localization.lang("Translate me");` instead of `Localization.lang(someVariable)` (possibly in the form `someVariable = Localization.lang("Translate me")`
* Use `%x`-variables where appropriate: `Localization.lang("Exported %0 entries.", number)` instead of `Localization.lang("Exported ") + number + Localization.lang(" entries.");`
* Use a full stop/period (".") to end full sentences

The tests check whether translation strings appear correctly in the resource bundles.
## Checking for correctness

The tests in `org.jabref.logic.l10n.LocalizationConsistencyTest` check whether translation strings appear correctly in the resource bundles.

## Adding a new key

1. Add new `Localization.lang("KEY")` to Java file. Run the `org.jabref.logic.LocalizationConsistencyTest`.
2. Tests fail. In the test output a snippet is generated which must be added to the English translation file.
Expand Down
4 changes: 2 additions & 2 deletions src/test/java/org/jabref/logic/l10n/LocalizationConsistencyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ void findMissingLocalizationKeys() throws IOException {
"""

DETECTED LANGUAGE KEYS WHICH ARE NOT IN THE ENGLISH LANGUAGE FILE
PASTE THESE INTO THE ENGLISH LANGUAGE FILE
PASTE THESE INTO THE ENGLISH LANGUAGE FILE "JabRef_en.properties"

""",
"\n\n")));
Expand All @@ -149,7 +149,7 @@ void findObsoleteLocalizationKeys() throws IOException {
"""

1. CHECK IF THE KEY IS REALLY NOT USED ANYMORE
2. REMOVE THESE FROM THE ENGLISH LANGUAGE FILE
2. REMOVE THESE FROM THE ENGLISH LANGUAGE FILE "JabRef_en.properties"

"""))
);
Expand Down
Loading