Keyword Tooltip/Cleanup for MSC codes added to Keyword Editor #12914

JustinHennis1 · 2025-04-09T03:39:09Z

Created a JSON file to hold key-value pairs of MSC codes to their respective descriptions/classifications by parsing msc_2020.pdf (which was provided in link to zbmath).

Created MscCodeUtils.java class that implements a method to load a JSON file and converts said file into a Map object.

Created ConvertMSCCodesCleanupTest.java, added to panel, and when user selects preference to convert and saves, the codes are converted to descriptions. Alternatively, when unselected, descriptions are reverted back to code.

In KeywordsEditor.java I added a private variable, mscmap, that calls the above method. Using this map object, I added a condition in the create tag method to check if the label text matches any of the keys. If it does, then we initialize a Tooltip and call install onMouseEnter and uninstall onMouseExited.

ToolTip

Cleanup

Before:

After:

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (if change is visible to the user)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

Siedlerchr · 2025-04-09T19:06:19Z

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

@@ -50,6 +55,8 @@ public class KeywordsEditor extends HBox implements FieldEditorFX {
    private static final Logger LOGGER = LoggerFactory.getLogger(KeywordsEditor.class);
    private static final PseudoClass FOCUSED = PseudoClass.getPseudoClass("focused");

+    private Map<String, String> mscmap = MscCodeUtils.loadMscCodesFromJson("../../resources/main/org/jabref/gui/fieldeditors/msccodes/msc_codes.json");


This won't work inside a jar, you need to use class.getResource

… URL object

…to ktooltip updates from jabref main

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

src/main/java/org/jabref/gui/fieldeditors/msccodes/MscCodeUtils.java

…to ktooltip pulling changes from main to local

…till in progress

Siedlerchr · 2025-04-12T16:36:17Z

Please fix the failing tests before. This reduces the burden of us maintainers to review incomplete PRs

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

src/main/java/org/jabref/gui/fieldeditors/msccodes/MscCodeUtils.java

…iptions, bug: error when trying to cleanup when editor is open

…er and special characters were added

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

src/test/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanupTest.java

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

src/main/java/org/jabref/logic/cleanup/CleanupPreferences.java

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

src/main/java/org/jabref/logic/msc/MscCodeUtils.java

…to ktooltip adding changes from main

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

koppor · 2025-05-12T21:09:15Z

Closing this issue due to inactivity 💤 Please ping us if you intend to resume work on this one.

JustinHennis1 · 2025-05-12T22:38:08Z

Closing this issue due to inactivity 💤 Please ping us if you intend to resume work on this one.

Hey @koppor, I'm waiting on review. All checks pass and the feature is implemented.

Let me know if anything else is needed.

jabref-machine · 2025-05-13T07:35:25Z

Your pull request conflicts with the target branch.

Please merge upstream/main with your code. For a step-by-step guide to resolve merge conflicts, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.

src/main/java/org/jabref/gui/cleanup/CleanupAction.java

src/main/java/org/jabref/gui/cleanup/CleanupSingleAction.java

trag-bot · 2025-05-13T07:42:33Z

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

+        MSCMAP = tempMap;
+    }
+
+    public ConvertMSCCodesCleanup(BibEntryPreferences preferences, boolean convertToDescriptions) {


Boolean method parameters for public methods should be avoided. Better create two distinct methods which maybe call some private methods.

trag-bot · 2025-05-13T07:42:34Z

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

+                    conversionPossible = true;
+                }
+            } catch (MscCodeLoadingException e) {
+                logger.error(Localization.lang("Error loading MSC codes:", e));


The logger should include the exception as the last argument to properly log the stack trace, instead of converting it to a string.

koppor · 2025-05-13T08:45:17Z

For help regarding conflict resolution, the pinned message in the gitter chat may help: https://matrix.to/#/!FrLnwBcqmXcZxTMyJj:gitter.im/$9pWlaPYKu81WXXwaU2LLkXnwg_vVWwrJjHmkwfYG8Lo?via=gitter.im&via=matrix.org&via=tchncs.de

And, please, fix the submodules: https://devdocs.jabref.org/code-howtos/faq.html#submodules

koppor

Initial review

Where does src/main/resources/msc_codes.json come from? What is the license of the file?

Maybe, it could be downloaded during the build?

koppor · 2025-05-13T08:46:22Z

CHANGELOG.md

+- We added a feature to convert keywords that resemble MSC codes to their descriptions. [#12944](https://github.com/JabRef/jabref/issues/12944)
+- We added a tooltip to keywords that resemble Math Subject Classification(MSC) codes. [#12944](https://github.com/JabRef/jabref/issues/12944)


swapped the entries, as the abbreviation explanation should go first. Moreover, a space comes after the term and before the bracket.

Suggested change

- We added a feature to convert keywords that resemble MSC codes to their descriptions. [#12944](https://github.com/JabRef/jabref/issues/12944)

- We added a tooltip to keywords that resemble Math Subject Classification(MSC) codes. [#12944](https://github.com/JabRef/jabref/issues/12944)

- We added a tooltip to keywords that resemble Math Subject Classification (MSC) codes. [#12944](https://github.com/JabRef/jabref/issues/12944)

- We added a feature to convert keywords that resemble MSC codes to their descriptions. [#12944](https://github.com/JabRef/jabref/issues/12944)

koppor · 2025-05-13T08:47:02Z

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

+            Optional<HashBiMap<String, String>> optionalMscCodes = MscCodeUtils.loadMscCodesFromJson(resourceUrl);
+
+            if (optionalMscCodes.isPresent()) {
+                mscmap = optionalMscCodes.get();  // Unwrap the map if present


Remove this AI-generated comment

koppor · 2025-05-13T08:47:23Z

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

+            if (optionalMscCodes.isPresent()) {
+                mscmap = optionalMscCodes.get();  // Unwrap the map if present
+            } else {
+                LOGGER.warn(Localization.lang("Resource not found: msc_codes.json"));


No need for localization here - just normal log

koppor · 2025-05-13T08:47:35Z

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

+                mscmap = HashBiMap.create();
+            }
+        } catch (MscCodeLoadingException e) {
+            LOGGER.error(Localization.lang("Error loading MSC codes:", e));


No need for localization here - just normal log

and, no colon

--

Please review the AI generated code.

koppor · 2025-05-13T08:47:42Z

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

+        }
+    }
+
+


No two empty lines

koppor · 2025-05-13T08:48:58Z

src/main/java/org/jabref/logic/cleanup/CleanupWorker.java

    private final List<JabRefException> failures;
-
-    public CleanupWorker(BibDatabaseContext databaseContext, FilePreferences filePreferences, TimestampPreferences timestampPreferences) {
+


Why this? Remove these spaces

koppor · 2025-05-13T08:49:05Z

src/main/java/org/jabref/logic/cleanup/CleanupWorker.java

@@ -31,8 +38,9 @@ public List<FieldChange> cleanup(CleanupPreferences preset, BibEntry entry) {

        List<CleanupJob> jobs = determineCleanupActions(preset);
        List<FieldChange> changes = new ArrayList<>();
-        for (CleanupJob job : jobs) {
+        for (CleanupJob job : jobs) { 


Remove spaces at end

koppor · 2025-05-13T08:49:11Z

src/main/java/org/jabref/logic/cleanup/CleanupWorker.java

            changes.addAll(job.cleanup(entry));
+


Remove empty line

koppor · 2025-05-13T08:50:55Z

src/main/java/org/jabref/logic/cleanup/CleanupWorker.java

@@ -44,8 +52,18 @@ public List<FieldChange> cleanup(CleanupPreferences preset, BibEntry entry) {
    private List<CleanupJob> determineCleanupActions(CleanupPreferences preset) {
        List<CleanupJob> jobs = new ArrayList<>();

+        // Special handling for MSC code conversion


Use one term for the thing done: "description conversion" maybe? - the Boolean variable of the method contains description (which is good); this should be done trhoughout the code and ocmments.

koppor · 2025-05-13T08:51:14Z

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

+    /*
+     * Converts MSC codes found in keywords editor to their descriptions
+     */


This is a class comment -> move above public class

JustinHennis1 · 2025-05-13T18:00:14Z

Initial review

Where does src/main/resources/msc_codes.json come from? What is the license of the file?

Maybe, it could be downloaded during the build?

The link to zbmath shared in the issue description above takes you to a PDF, which I then converted, using a Python script, into the JSON file you see. I did not see any license. This json file is not an exact copy since changes had to be made to the format because of the "," delimiter. @koppor

koppor · 2025-05-13T18:39:34Z

The link to zbmath shared in the issue description above takes you to a PDF, which I then converted, using a Python script, into the JSON file you see.

Nice!

Please share the Python script (https://github.com/JabRef/jabref/tree/main/scripts)

I did not see any license. This json file is not an exact copy since changes had to be made to the format because of the "," delimiter. @koppor

OK. I think, in the context of JabRef usage, this is OK.

JustinHennis1 and others added 3 commits April 8, 2025 22:38

added msc codes, keyword tooltip feature

0f77aba

keyword tooltip feature#423, changelog updated

9cec66b

Merge branch 'main' into ktooltip

3a506b4

Siedlerchr reviewed Apr 9, 2025

View reviewed changes

JustinHennis1 added 4 commits April 9, 2025 21:11

uses getResource to find json/loadMscCodesFromJson overloaded to take…

a09718f

… URL object

Merge branch 'ktooltip' of https://github.com/JustinHennis1/jabref in…

1ce8ec0

…to ktooltip updates from jabref main

printstacktrace removed from MscCodeUtils

92d0f60

Switched from File to Path.of in loadMscFromJson

0d57263

JustinHennis1 closed this Apr 10, 2025

Merge branch 'JabRef:main' into ktooltip

f5f16b1

JustinHennis1 reopened this Apr 10, 2025

trag-bot bot reviewed Apr 10, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 10, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 10, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/msccodes/MscCodeUtils.java Outdated Show resolved Hide resolved

JustinHennis1 added 3 commits April 10, 2025 01:15

checkstyle compliance

8d0af60

Merge branch 'ktooltip' of https://github.com/JustinHennis1/jabref in…

6d14ec9

…to ktooltip pulling changes from main to local

fixed markdown check

4fa4d10

JustinHennis1 requested a review from Siedlerchr April 11, 2025 04:55

Added logic for MSC code conversion cleanup. Actual cleanup() logic s…

24d5112

…till in progress

Siedlerchr reviewed Apr 12, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java Outdated Show resolved Hide resolved

Siedlerchr reviewed Apr 12, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/msccodes/MscCodeUtils.java Outdated Show resolved Hide resolved

added secondary cleanup to convert keywords in entries to their descr…

1ab572d

…iptions, bug: error when trying to cleanup when editor is open

JustinHennis1 closed this Apr 13, 2025

github-actions bot mentioned this pull request Apr 13, 2025

Clean up unsupported entrytype "other" or "conversion dialog" in JabRef 3.0+ #423

Closed

JustinHennis1 added 3 commits April 14, 2025 03:19

MSC code cleanup functional, msc_codes.json cleaned for comma delimit…

a1d0c92

…er and special characters were added

Cleaned msc json for extra commas

475c3b9

Tests updated for msc code conversion

b3e11f5

JustinHennis1 reopened this Apr 14, 2025

trag-bot bot reviewed Apr 14, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 16, 2025

View reviewed changes

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java Show resolved Hide resolved

trag-bot bot reviewed Apr 16, 2025

View reviewed changes

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java Show resolved Hide resolved

trag-bot bot reviewed Apr 16, 2025

View reviewed changes

src/test/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanupTest.java Show resolved Hide resolved

Merge branch 'main' into ktooltip

da15de2

JustinHennis1 marked this pull request as ready for review April 16, 2025 23:49

trag-bot bot reviewed Apr 16, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java Show resolved Hide resolved

trag-bot bot reviewed Apr 16, 2025

View reviewed changes

src/main/java/org/jabref/logic/cleanup/CleanupPreferences.java Show resolved Hide resolved

trag-bot bot reviewed Apr 16, 2025

View reviewed changes

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 16, 2025

View reviewed changes

src/main/java/org/jabref/logic/msc/MscCodeUtils.java Show resolved Hide resolved

JustinHennis1 and others added 3 commits April 17, 2025 19:44

Merge branch 'main' into ktooltip

fa09a62

Language Localizations added, FF principle fixes

88fbaff

Merge branch 'ktooltip' of https://github.com/JustinHennis1/jabref in…

6f7ac45

…to ktooltip adding changes from main

Siedlerchr reviewed Apr 18, 2025

View reviewed changes

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java Outdated Show resolved Hide resolved

JustinHennis1 added 2 commits April 19, 2025 19:53

Bimap implemented, fixes unhandled except, msc codes edited

019ce37

Checkstyle fixes

9f7f31d

JustinHennis1 requested a review from Siedlerchr April 20, 2025 05:45

Merge branch 'main' into ktooltip

c27e0e1

koppor closed this May 12, 2025

koppor reopened this May 13, 2025

trag-bot bot reviewed May 13, 2025

View reviewed changes

src/main/java/org/jabref/gui/cleanup/CleanupAction.java Show resolved Hide resolved

trag-bot bot reviewed May 13, 2025

View reviewed changes

src/main/java/org/jabref/gui/cleanup/CleanupSingleAction.java Show resolved Hide resolved

trag-bot bot reviewed May 13, 2025

View reviewed changes

koppor requested changes May 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Keyword Tooltip/Cleanup for MSC codes added to Keyword Editor #12914

Keyword Tooltip/Cleanup for MSC codes added to Keyword Editor #12914

JustinHennis1 commented Apr 9, 2025 •

edited

Loading

Siedlerchr Apr 9, 2025

Siedlerchr commented Apr 12, 2025

koppor commented May 12, 2025

JustinHennis1 commented May 12, 2025

jabref-machine commented May 13, 2025

trag-bot bot May 13, 2025

trag-bot bot May 13, 2025

koppor commented May 13, 2025

koppor left a comment

koppor May 13, 2025

koppor May 13, 2025

koppor May 13, 2025

koppor May 13, 2025

koppor May 13, 2025

koppor May 13, 2025

koppor May 13, 2025

koppor May 13, 2025

koppor May 13, 2025

koppor May 13, 2025

JustinHennis1 commented May 13, 2025

koppor commented May 13, 2025

		- We added a feature to convert keywords that resemble MSC codes to their descriptions. [#12944](https://github.com/JabRef/jabref/issues/12944)
		- We added a tooltip to keywords that resemble Math Subject Classification(MSC) codes. [#12944](https://github.com/JabRef/jabref/issues/12944)

		private final List<JabRefException> failures;

		public CleanupWorker(BibDatabaseContext databaseContext, FilePreferences filePreferences, TimestampPreferences timestampPreferences) {

Keyword Tooltip/Cleanup for MSC codes added to Keyword Editor #12914

Are you sure you want to change the base?

Keyword Tooltip/Cleanup for MSC codes added to Keyword Editor #12914

Conversation

JustinHennis1 commented Apr 9, 2025 • edited Loading

ToolTip

Cleanup

Before:

After:

Mandatory checks

Choose a reason for hiding this comment

Siedlerchr commented Apr 12, 2025

koppor commented May 12, 2025

JustinHennis1 commented May 12, 2025

jabref-machine commented May 13, 2025

trag-bot bot May 13, 2025

Choose a reason for hiding this comment

trag-bot bot May 13, 2025

Choose a reason for hiding this comment

koppor commented May 13, 2025

koppor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JustinHennis1 commented May 13, 2025

koppor commented May 13, 2025

JustinHennis1 commented Apr 9, 2025 •

edited

Loading