Merge pull request #7231 from IllianiBird/newGlossaryInitial

Improvement: Replaced Placeholder Glossary with New Layout and Functionality

Author: rjhancock

MekHQ/build.gradle

@@ -81,6 +81,8 @@ dependencies {
     implementation 'org.apache.commons:commons-text:1.13.1'
     implementation 'org.apache.logging.log4j:log4j-core:2.24.3'
 
+    implementation 'org.apache.pdfbox:pdfbox:3.0.5'
+
     implementation 'org.commonmark:commonmark:0.24.0'
 
     implementation 'org.jfree:jfreechart:1.5.6'

…/docs/0_MHQ New Player Guide v0.18.5.pdf MekHQ/docs/0_MHQ New Player Guide.pdfMekHQ/docs/0_MHQ New Player Guide v0.18.5.pdf renamed to MekHQ/docs/0_MHQ New Player Guide.pdf MekHQ/docs/0_MHQ New Player Guide v0.18.5.pdf renamed to MekHQ/docs/0_MHQ New Player Guide.pdf

@@ -0,0 +1,20 @@
+# suppress inspection "UnusedProperty" for the whole file
+AGING_EFFECTS.title=Aging
+AWARDS_MODULE.title=Awards
+EDUCATION_MODULE.title=Education
+RANDOM_DEATH.title=Random Death
+RANDOM_DEPENDENTS.title=Random Civilians
+RANDOM_PERSONALITIES.title=Random Personalities
+STARTING_ATTRIBUTE_SCORES.title=Starting Attribute Scores
+TURNOVER_AND_RETENTION.title=Turnover & Retention (feat. Fatigue)
+PRISONERS_OF_WAR.title=Prisoners of War & Abstracted Search and Rescue
+ACAR.title=ACAR (Abstract Combat AutoResolve)
+ADMIN_SKILLS.title=Admin Skills
+COMBAT_TEAMS.title=Combat Teams, Roles, Training & Reinforcements
+MORALE.title=MekHQ Morale
+RESUPPLY_AND_CONVOYS.title=Resupply & Convoys
+UNIT_MARKETS.title=Unit Markets
+CHAOS_CAMPAIGNS.title=Chaos Campaigns in MekHQ
+COOP_CAMPAIGNS.title=Co-op Campaigns in MekHQ
+AUTOMATIC_AMMO_ASSIGNMENT.title=Automatic Ammunition Tool
+NEW_PLAYER_GUIDE.title=New & Returning Player Guide

MekHQ/resources/mekhq/resources/DocumentationEntry.properties

@@ -0,0 +1,9 @@
+GlossaryDialog.title=++ACCESSING DATABASE++
+GlossaryDialog.contentsPane.title=<h2 style="text-align:center;">Contents</h2>
+GlossaryDialog.documentationPane.title=<h2 style="text-align:center;">Documentation</h2>
+GlossaryDialog.aboutPane=<h1 style="text-align:center;">MekHQ Glossary</h1>This Glossary includes a wealth of \
+  information about MekHQ and its systems. It is, however, a work in progress. If there is something you think is \
+  missing, or incomplete, please let us know!
+GlossaryDialog.button.close=Close
+GlossaryDialog.button.closeTab.single=Close Tab
+GlossaryDialog.button.closeTab.all=Close All

MekHQ/resources/mekhq/resources/GlossaryEntry.properties

@@ -0,0 +1,149 @@
+/*
+ * Copyright (C) 2025 The MegaMek Team. All Rights Reserved.
+ *
+ * This file is part of MekHQ.
+ *
+ * MekHQ is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPL),
+ * version 3 or (at your option) any later version,
+ * as published by the Free Software Foundation.
+ *
+ * MekHQ is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details.
+ *
+ * A copy of the GPL should have been included with this project;
+ * if not, see <https://www.gnu.org/licenses/>.
+ *
+ * NOTICE: The MegaMek organization is a non-profit group of volunteers
+ * creating free software for the BattleTech community.
+ *
+ * MechWarrior, BattleMech, `Mech and AeroTech are registered trademarks
+ * of The Topps Company, Inc. All Rights Reserved.
+ *
+ * Catalyst Game Labs and the Catalyst Game Labs logo are trademarks of
+ * InMediaRes Productions, LLC.
+ *
+ * MechWarrior Copyright Microsoft Corporation. MekHQ was created under
+ * Microsoft's "Game Content Usage Rules"
+ * <https://www.xbox.com/en-US/developers/rules> and it is not endorsed by or
+ * affiliated with Microsoft.
+ */
+package mekhq.campaign.utilities.glossary;
+
+import static mekhq.utilities.MHQInternationalization.getTextAt;
+
+import java.util.List;
+
+/**
+ * The {@code DocumentationEntry} enum represents individual entries in the documentation glossary.
+ *
+ * <p>Each enum constant is associated with a lookup name used to fetch localized strings.</p>
+ *
+ * <p>This class provides methods to retrieve localized titles, sort entries, and look up entries by name.</p>
+ *
+ * @author Illiani
+ * @since 0.50.07
+ */
+public enum DocumentationEntry {
+    AGING_EFFECTS("AGING_EFFECTS", "Personnel Modules/Aging Effects"),
+    AWARDS_MODULE("AWARDS_MODULE", "Personnel Modules/Awards Module"),
+    EDUCATION_MODULE("EDUCATION_MODULE", "Personnel Modules/Education Module"),
+    RANDOM_DEATH("RANDOM_DEATH", "Personnel Modules/Random Death in MekHQ"),
+    RANDOM_DEPENDENTS("RANDOM_DEPENDENTS", "Personnel Modules/Random Dependents"),
+    RANDOM_PERSONALITIES("RANDOM_PERSONALITIES", "Personnel Modules/Random Personalities"),
+    STARTING_ATTRIBUTE_SCORES("STARTING_ATTRIBUTE_SCORES", "Personnel Modules/Starting Attribute Scores"),
+    TURNOVER_AND_RETENTION("TURNOVER_AND_RETENTION", "Personnel Modules/Turnover & Retention Module (feat. Fatigue)"),
+    PRISONERS_OF_WAR("PRISONERS_OF_WAR", "Random Events/Prisoners of War & Abstracted Search and Rescue"),
+    ACAR("ACAR", "StratCon/ACAR-Abstract Combat Auto-Resolve documentation"),
+    ADMIN_SKILLS("ADMIN_SKILLS", "StratCon/Admin Skills"),
+    COMBAT_TEAMS("COMBAT_TEAMS", "StratCon/Combat Teams, Roles, Training & Reinforcements"),
+    MORALE("MORALE", "StratCon/MekHQ Morale"),
+    RESUPPLY_AND_CONVOYS("RESUPPLY_AND_CONVOYS", "StratCon/Resupply & Convoys"),
+    UNIT_MARKETS("UNIT_MARKETS", "StratCon/Unit Markets"),
+    CHAOS_CAMPAIGNS("CHAOS_CAMPAIGNS", "MegaMek -MekHQ Chaos Campaign Guide"),
+    COOP_CAMPAIGNS("COOP_CAMPAIGNS", "MekHQ Co-Op Campaign Guide v1"),
+    NEW_PLAYER_GUIDE("NEW_PLAYER_GUIDE", "0_MHQ New Player Guide");
+
+    private static final String RESOURCE_BUNDLE = "mekhq.resources.DocumentationEntry";
+
+    private final String DIRECTORY = "docs/";
+    private final String FILE_EXTENSION = ".pdf";
+
+    private final String lookUpName;
+    private final String fileAddress;
+
+    /**
+     * Constructs a {@code DocumentationEntry} with the specified lookup name.
+     *
+     * @param lookUpName the resource key used to look up this entry's localized strings
+     * @param fileAddress the document address
+     *
+     * @author Illiani
+     * @since 0.50.07
+     */
+    DocumentationEntry(String lookUpName, String fileAddress) {
+        this.lookUpName = lookUpName;
+        this.fileAddress = fileAddress;
+    }
+
+    /**
+     * Returns the localized title for this documentation entry.
+     *
+     * @return the title string for this entry
+     *
+     * @author Illiani
+     * @since 0.50.07
+     */
+    public String getTitle() {
+        return getTextAt(RESOURCE_BUNDLE, lookUpName + ".title");
+    }
+
+    /**
+     * Returns the full file address for this object by concatenating the directory path, the stored file address, and
+     * the file extension constants.
+     *
+     * @return the complete file address as a String
+     *
+     * @author Illiani
+     * @since 0.50.07
+     */
+    public String getFileAddress() {
+        return DIRECTORY + fileAddress + FILE_EXTENSION;
+    }
+
+    /**
+     * Returns a list of all lookup names, sorted by their corresponding localized titles in ascending order.
+     *
+     * @return a list of lookup names sorted by title
+     *
+     * @author Illiani
+     * @since 0.50.07
+     */
+    public static List<String> getLookUpNamesSortedByTitle() {
+        return java.util.Arrays.stream(DocumentationEntry.values())
+                     .sorted(java.util.Comparator.comparing(DocumentationEntry::getTitle))
+                     .map(entry -> entry.lookUpName)
+                     .toList();
+    }
+
+    /**
+     * Returns the {@code DocumentationEntry} associated with the given lookup name, or {@code null} if not found.
+     *
+     * @param lookUpName the lookup name to search for
+     *
+     * @return the corresponding {@code DocumentationEntry} if found; {@code null} otherwise
+     *
+     * @author Illiani
+     * @since 0.50.07
+     */
+    public static DocumentationEntry getDocumentationEntryFromLookUpName(String lookUpName) {
+        for (DocumentationEntry entry : DocumentationEntry.values()) {
+            if (entry.lookUpName.equals(lookUpName)) {
+                return entry;
+            }
+        }
+        return null;
+    }
+}