Improve devdocs for localization (JabRef#11356)

* Improve devdocs for localization * Fixup * Add file hint
koppor · Jun 4, 2024 · dba4d0c · dba4d0c
1 parent 109600b
commit dba4d0c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/docs/code-howtos/localization.md b/docs/code-howtos/localization.md
@@ -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.

diff --git a/src/test/java/org/jabref/logic/l10n/LocalizationConsistencyTest.java b/src/test/java/org/jabref/logic/l10n/LocalizationConsistencyTest.java
@@ -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")));
@@ -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"
 
                                 """))
         );