Add all missing EditorMessageBox translation keys to Translation_en.ini, adjust some translation keys, update documentation

Author: Rampastring

src/TSMapEditor/Config/Translations.ini

@@ -1,7 +1,30 @@
+; C&C World-Altering Editor
+; Translation language list file
+; https://github.com/CnCNet/WorldAlteringEditor
+
+
+; Defines all languages available in the editor.
+; The editor expects this file to contain a separate section for all languages defined in this file.
 [Translations]
 0=English
 
+
+; Individual language control sections.
+; Available keys:
+; UIName=Name of the language as shown in the user-interface.
+;
+; Directory=<string>, specifies the sub-directory inside the Translations folder that the translation's files exist in.
+;           Also used as the suffix in translation file names (for example, if Directory=en, the editor reads
+;           ObjectNames_en.ini and Translation_en.ini). Should always be just a short, internationally understood
+;           language identifier.
+;
+; IniFileEncoding=<int> can define an encoding codepage for the INI parser to use when reading the languages's INI files.
+;                  If unspecified, the editor defaults to UTF-8 (which should be generally sufficient).
+;
+; IsReference=<bool>, if set to yes/true, then the translation is treated as a "reference language" and its translation file
+;             is not actually used, but default strings are returned instead. Should not be used for anything else than English.
+
 [English]
 UIName=English
 Directory=en
-
+IsReference=yes

src/TSMapEditor/Config/Translations/en/Translation_en.ini

@@ -15,7 +15,7 @@ public class Translation
 
         private static Dictionary<string, string> ObjectNames = new Dictionary<string, string>();
 
-        public Translation(string internalName, string directoryName, string uiName, int index)
+        public Translation(string internalName, string directoryName, string uiName, int index, bool isReference)
         {
             if (string.IsNullOrWhiteSpace(internalName))
                 throw new ArgumentException("Translation internal name cannot be empty.");
@@ -27,6 +27,7 @@ public Translation(string internalName, string directoryName, string uiName, int
             DirectoryName = directoryName;
             UIName = uiName;
             Index = index;
+            IsReference = isReference;
         }
 
         public Translation(IniSection definitionSection, int index)
@@ -40,10 +41,12 @@ public Translation(IniSection definitionSection, int index)
             if (string.IsNullOrWhiteSpace(DirectoryName))
                 throw new InvalidOperationException("DirectoryName cannot be empty for a translation. Translation section: " + definitionSection.SectionName);
 
-            UIName = definitionSection.GetStringValue("UIName", null);
+            UIName = definitionSection.GetStringValue(nameof(UIName), null);
             if (string.IsNullOrWhiteSpace(UIName))
                 throw new InvalidOperationException("UIName cannot be empty for a translation. Translation section: " + definitionSection.SectionName);
 
+            IsReference = definitionSection.GetBooleanValue(nameof(IsReference), false);
+
             if (definitionSection.KeyExists(nameof(IniFileEncoding)))
             {
                 IniFileEncoding = Encoding.GetEncoding(definitionSection.GetIntValue(nameof(IniFileEncoding), 0));
@@ -62,6 +65,8 @@ public Translation(IniSection definitionSection, int index)
 
         public int Index { get; }
 
+        public bool IsReference { get; }
+
         private string ProcessEscapes(string str)
         {
             return str.Replace("\\s", " ").Replace("@", Environment.NewLine);
@@ -117,6 +122,15 @@ public void Load()
 
         public string Translate(string identifier, string defaultString)
         {
+            // Reference translations always return the supplied default string, but still log missing values.
+            if (IsReference)
+            {
+                if (defaultString != null && !MissingValues.ContainsKey(identifier))
+                    MissingValues[identifier] = defaultString;
+
+                return defaultString;
+            }
+
             if (UIStringTable.TryGetValue(identifier, out var result))
                 return result;
 
@@ -235,7 +249,7 @@ public static void LoadTranslations()
             }
             else
             {
-                var englishTranslation = new Translation("English", "en", "English", Translations.Count);
+                var englishTranslation = new Translation("English", "en", "English", Translations.Count, true);
                 AddTranslation(englishTranslation);
             }
         }

src/TSMapEditor/Misc/Translator.cs

@@ -299,8 +299,8 @@ private void TrySaveMap()
                 {
                     Logger.Log("Failed to save the map file. Returned error message: " + ex.Message);
 
-                    EditorMessageBox.Show(WindowManager, Translate(this, "MapSaveFailedTitle", "Failed to save map"),
-                        string.Format(Translate(this, "MapSaveFailedDescription",
+                    EditorMessageBox.Show(WindowManager, Translate(this, "MapSaveFailed.Title", "Failed to save map"),
+                        string.Format(Translate(this, "MapSaveFailed.Description",
                             "Failed to write the map file. Please make sure that WAE has write access to the path." + Environment.NewLine + Environment.NewLine +
                             "A common source of this error is trying to save the map to Program Files or another" + Environment.NewLine +
                             "write-protected directory without running WAE with administrative rights." + Environment.NewLine + Environment.NewLine +
@@ -316,8 +316,8 @@ private void TrySaveMap()
 
         private void WriteMapPreviewConfirmation()
         {
-            var messageBox = EditorMessageBox.Show(WindowManager, Translate(this, "GenerateMapPreviewConfirmationTitle", "Confirmation"),
-                Translate(this, "GenerateMapPreviewConfirmationDescription", "This will write the current minimap as the map preview to the map file." + Environment.NewLine + Environment.NewLine +
+            var messageBox = EditorMessageBox.Show(WindowManager, Translate(this, "GenerateMapPreviewConfirmation.Title", "Confirmation"),
+                Translate(this, "GenerateMapPreviewConfirmation.Description", "This will write the current minimap as the map preview to the map file." + Environment.NewLine + Environment.NewLine +
                 "This provides the map with a preview if it is used as a custom map" + Environment.NewLine + 
                 "in the CnCNet Client or in-game, but is not necessary if the map will" + Environment.NewLine +
                 "have an external preview. It will also significantly increase the size" + Environment.NewLine +

src/TSMapEditor/UI/TopBar/TopBarMenu.cs

@@ -408,10 +408,10 @@ private void CheckForIssuesAfterManualSave(object sender, EventArgs e)
 
                 EditorMessageBox.Show(WindowManager, 
                     Translate(this, "IssuesFound.Title", "Issues Found"),
-                    Translate(this, "IssuesFound.Description", 
+                    string.Format(Translate(this, "IssuesFound.Description", 
                         "The map has been saved, but one or more issues have been found in the map. Please consider resolving them." +
                         newline + newline +
-                        issuesString),
+                        "{0}"), issuesString),
                     MessageBoxButtons.OK);
             }
         }

src/TSMapEditor/UI/UIManager.cs

@@ -111,9 +111,9 @@ private void CloneForEasierDifficulties()
                 "setting for each AI trigger to Medium and Easy, respectively." + Environment.NewLine +
                 "This will set the current AI trigger's difficulty to Hard only." + Environment.NewLine + Environment.NewLine +
                 "In case the AI trigger references a Primary or Secondary TeamTypes," + Environment.NewLine +
-                "those TeamTypes and their TaskForoces would be duplicated for easier difficulties." + Environment.NewLine +
-                "If those duplicates already exist, this action will set the AI triggers to use those " + Environment.NewLine +
-                "TeamTypes instead." + Environment.NewLine + Environment.NewLine +
+                "those TeamTypes and their TaskForces will be duplicated for easier" + Environment.NewLine +
+                "difficulties. If those duplicates already exist, this action will set" + Environment.NewLine +
+                "the AI triggers to use those TeamTypes instead." + Environment.NewLine + Environment.NewLine +
                 "The script assumes that this AI Trigger has the words 'H' or 'Hard'" + Environment.NewLine +
                 "in their name and in their respective TeamTypes and TaskForces." + Environment.NewLine + Environment.NewLine +
                 "No un-do is available. Do you want to continue?"),

src/TSMapEditor/UI/Windows/AITriggersWindow.cs

@@ -55,7 +55,7 @@ private void BtnApplyFile_LeftClick(object sender, EventArgs e)
             {
                 confirmation = Renderer.FixText(confirmation, Constants.UIDefaultFont, Width).Text;
 
-                var messageBox = EditorMessageBox.Show(WindowManager, Translate(this, "Confirm", "Are you sure?"),
+                var messageBox = EditorMessageBox.Show(WindowManager, Translate(this, "ConfirmationTitle", "Are you sure?"),
                     confirmation, MessageBoxButtons.YesNo);
                 messageBox.YesClickedAction = (_) => ApplyCode();
             }

src/TSMapEditor/UI/Windows/ApplyINICodeWindow.cs

@@ -113,7 +113,7 @@ private bool Validate()
             {
                 EditorMessageBox.Show(WindowManager, 
                     Translate(this, "ValidateMissingTriggerName.Title", "Missing Trigger Name"),
-                    Translate(this, "ValidateMissingTriggerName.Description", "Please enter a name for the triggers"),
+                    Translate(this, "ValidateMissingTriggerName.Description", "Please enter a name for the triggers."),
                     MessageBoxButtons.OK);
                 return false;
             }
@@ -122,7 +122,7 @@ private bool Validate()
             {
                 EditorMessageBox.Show(WindowManager, 
                     Translate(this, "InvalidTriggersNumber.Title", "Invalid Number of Triggers"),
-                    Translate(this, "InvalidTriggersNumber.Description", "Please enter a value of 2 or more"),
+                    Translate(this, "InvalidTriggersNumber.Description", "Please enter a value of 2 or more."),
                     MessageBoxButtons.OK);
                 return false;
             }
@@ -131,7 +131,7 @@ private bool Validate()
             {
                 EditorMessageBox.Show(WindowManager, 
                     Translate(this, "InvalidElapsedTime.Title", "Invalid Elapsed Time"),
-                    Translate(this, "InvalidElapsedTime.Description", "Please enter a value of 0 or more"),
+                    Translate(this, "InvalidElapsedTime.Description", "Please enter a value of 0 or more."),
                     MessageBoxButtons.OK);
                 return false;
             }
@@ -140,7 +140,7 @@ private bool Validate()
             {
                 EditorMessageBox.Show(WindowManager,
                     Translate(this, "InvalidRandomDelay.Title", "Invalid Random Delay"),
-                    Translate(this, "InvalidRandomDelay.Description", "Please enter a value of 10 or more"),
+                    Translate(this, "InvalidRandomDelay.Description", "Please enter a value of 10 or more."),
                     MessageBoxButtons.OK);
                 return false;
             }

src/TSMapEditor/UI/Windows/CreateRandomTriggerSetWindow.cs

@@ -46,7 +46,7 @@ private void BtnApply_LeftClick(object sender, EventArgs e)
                 EditorMessageBox.Show(WindowManager, 
                     Translate(this, "InvalidWidth.Title", "Invalid width"),
                     string.Format(Translate(this, "InvalidWidth.Description", 
-                    "The given values would make the map's width {0}.\r\nIt should be between 1 and {1}."),
+                    "The given values would make the map's width {0}." + Environment.NewLine + "It should be between 1 and {1}."),
                         newWidth, Constants.MaxMapWidth),
                     MessageBoxButtons.OK);
 
@@ -59,7 +59,7 @@ private void BtnApply_LeftClick(object sender, EventArgs e)
                 EditorMessageBox.Show(WindowManager, 
                     Translate(this, "InvalidHeight.Title", "Invalid height"),
                     string.Format(Translate(this, "InvalidHeight.Description",
-                        "The given values would make the map's height {0}.\r\nIt should be between 0 and {1}."),
+                        "The given values would make the map's height {0}." + Environment.NewLine + "It should be between 0 and {1}."),
                             newHeight, Constants.MaxMapHeight),
                     MessageBoxButtons.OK);
 

src/TSMapEditor/UI/Windows/ExpandMapWindow.cs

@@ -157,14 +157,14 @@ private void BtnViewVariableUsages_LeftClick(object sender, EventArgs e)
             {
                 EditorMessageBox.Show(WindowManager,
                     Translate(this, "NoUsagesFound.Title", "No usages found"),
-                    string.Format(Translate(this, "NoUsagesMessage.Description", "No triggers or scripts make use of the selected local variable '{0}'"), editedLocalVariable.Name),
+                    string.Format(Translate(this, "NoUsagesFound.Description", "No triggers or scripts make use of the selected local variable '{0}'"), editedLocalVariable.Name),
                     MessageBoxButtons.OK);
             }
             else
             {
                 EditorMessageBox.Show(WindowManager,
                     Translate(this, "LocalVariableUsages.Title", "Local Variable Usages"),
-                    string.Format(Translate(this, "LocalVariablesUsages.Description", "The following usages were found for the selected local variable '{0}':"), editedLocalVariable.Name) + Environment.NewLine + Environment.NewLine +
+                    string.Format(Translate(this, "LocalVariableUsages.Description", "The following usages were found for the selected local variable '{0}':"), editedLocalVariable.Name) + Environment.NewLine + Environment.NewLine +
                     string.Join(Environment.NewLine, list.Select(e => "- " + e)),
                     MessageBoxButtons.OK);
             }