#293 Add comments to help file, migrate header setting, write tests

src/main/resources/config.yml

@@ -41,8 +41,6 @@ DataSource:
     # Column for RealName
     mySQLRealName: realname
 settings:
-    # The name shown in the help messages.
-    helpHeader: AuthMeReloaded
     sessions:
         # Do you want to enable the session feature?
         # If enabled, when a player authenticates successfully,

src/main/resources/messages/help_de.yml

@@ -10,8 +10,8 @@ common:
         allowed: 'Allen erlaubt'
 section:
     command: 'Kommando'
-    description.short: 'Beschreibung'
-    description.detailed: 'Detaillierte Beschreibung'
+    description: 'Beschreibung'
+    detailedDescription: 'Detaillierte Beschreibung'
     arguments: 'Argumente'
     permissions: 'Rechte'
     alternatives: 'Alternativen'

src/main/resources/messages/help_en.yml

@@ -1,4 +1,9 @@
+# Translation config for the AuthMe help, e.g. when /authme help or /authme help register is called
+
+# -------------------------------------------------------
+# List of texts used in the help section
 common:
+    header: '==========[ AuthMeReloaded HELP ]=========='
     optional: 'Optional'
     hasPermission: 'You have permission'
     noPermission: 'No permission'
@@ -8,14 +13,25 @@ common:
         notAllowed: 'No permission'
         opOnly: 'OP''s only'
         allowed: 'Everyone allowed'
+
+# -------------------------------------------------------
+# Titles of the individual help sections
+# Set the translation text to empty text to disable the section, e.g. to hide alternatives:
+#   alternatives: ''
 section:
     command: 'Command'
-    description.short: 'Short description'
-    description.detailed: 'Detailed description'
+    description: 'Short description'
+    detailedDescription: 'Detailed description'
     arguments: 'Arguments'
     permissions: 'Permissions'
     alternatives: 'Alternatives'
     children: 'Commands'
+
+# -------------------------------------------------------
+# You can translate the data for all commands using the below pattern.
+# So for example to translate /authme reload, create a section "authme.reload", or "login" for /login
+# If the command has arguments, you can use arg1 as below to translate the first argument, and so forth
+# Translations don't need to be complete; any missing section will be taken from the default silently
 commands:
     authme.register:
         description: 'Register a player'