Standardise the messages for translations

EngineHub · Jun 15, 2019 · 1614def · 1614def
1 parent f76a4c9
commit 1614def
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 8 deletions.
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/command/ExpandCommands.java b/worldedit-core/src/main/java/com/sk89q/worldedit/command/ExpandCommands.java
@@ -88,7 +88,7 @@ public static void register(CommandRegistrationHandler registration,
 
     private static Command createVertCommand(CommandManager commandManager) {
         return commandManager.newCommand("vert")
-            .description(TranslatableComponent.of("worldedit.commands.expand.vert.description"))
+            .description(TranslatableComponent.of("worldedit.expand.description.vert"))
             .action(parameters -> {
                 expandVert(
                     requireIV(Key.of(LocalSession.class), "localSession", parameters),
@@ -111,7 +111,7 @@ private static void expandVert(LocalSession session, Player player) throws Incom
             session.getRegionSelector(player.getWorld()).explainRegionAdjust(player, session);
             int changeSize = newSize - oldSize;
             player.printInfo(
-                    TranslatableComponent.of(pluraliseI18n("worldedit.region.expanded.vert", changeSize), TextComponent.of(changeSize))
+                    TranslatableComponent.of(pluraliseI18n("worldedit.expand.expanded.vert", changeSize), TextComponent.of(changeSize))
             );
         } catch (RegionOperationException e) {
             player.printError(e.getMessage());
@@ -150,7 +150,7 @@ public void expand(Player player, LocalSession session,
         session.getRegionSelector(player.getWorld()).explainRegionAdjust(player, session);
 
         int changeSize = newSize - oldSize;
-        player.printInfo(TranslatableComponent.of(pluraliseI18n("worldedit.region.expanded", changeSize), TextComponent.of(changeSize)));
+        player.printInfo(TranslatableComponent.of(pluraliseI18n("worldedit.expand.expanded", changeSize), TextComponent.of(changeSize)));
     }
 
 }
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/util/translation/TranslationManager.java b/worldedit-core/src/main/java/com/sk89q/worldedit/util/translation/TranslationManager.java
@@ -42,6 +42,18 @@
 import java.util.Optional;
 import java.util.Set;
 
+/**
+ * Handles translations for the plugin.
+ *
+ * These should be in the following format:
+ * plugin.component.message[.meta]*
+ *
+ * Where,
+ * plugin = worldedit
+ * component = The part of the plugin, eg expand
+ * message = A descriptor for which message, eg, expanded
+ * meta = Any extra information such as plural/singular (Can have none to infinite)
+ */
 public class TranslationManager {
 
     private static final Gson gson = new GsonBuilder().create();

diff --git a/worldedit-core/src/main/resources/lang/strings.json b/worldedit-core/src/main/resources/lang/strings.json
@@ -1,7 +1,7 @@
 {
-    "worldedit.commands.expand.vert.description": "Vertically expand the selection to world limits.",
-    "worldedit.region.expanded.singular": "Region expanded {0} block",
-    "worldedit.region.expanded.plural": "Region expanded {0} blocks",
-    "worldedit.region.expanded.vert.singular": "Region expanded {0} block [top-to-bottom].",
-    "worldedit.region.expanded.vert.plural": "Region expanded {0} blocks [top-to-bottom]."
+    "worldedit.expand.description.vert": "Vertically expand the selection to world limits.",
+    "worldedit.expand.expanded.singular": "Region expanded {0} block",
+    "worldedit.expand.expanded.plural": "Region expanded {0} blocks",
+    "worldedit.expand.expanded.vert.singular": "Region expanded {0} block [top-to-bottom].",
+    "worldedit.expand.expanded.vert.plural": "Region expanded {0} blocks [top-to-bottom]."
 }