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

koppor

The logic seems to require a JavaFX thread. This must not happen.

Logic should be able to run in a jar file without any gui.

See https://foojay.social/@jabref/114520065589122649

.gitignore

jablib/src/main/java/org/jabref/logic/util/MscCodeUtils.java

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

koppor · 2025-05-19T07:55:26Z

jablib/src/main/resources/msc2020.pdf needs to be places in jablib/src/misc/, because it is NOT used at users's side - and thus should not be placed inside the distribution of JabRef. I could not came up with a better name than misc 😅

Co-authored-by: Oliver Kopp <[email protected]>

jablib/src/main/java/org/jabref/logic/util/MscCodeUtils.java

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

JustinHennis1 · 2025-05-19T18:37:34Z

jablib/src/main/resources/msc2020.pdf needs to be places in jablib/src/misc/, because it is NOT used at users's side - and thus should not be placed inside the distribution of JabRef. I could not came up with a better name than misc 😅

Does this directory exist? jablib/src/misc/ does not exist even after updating my branch with the latest.

koppor · 2025-05-19T22:54:16Z

jablib/src/main/resources/msc2020.pdf needs to be places in jablib/src/misc/, because it is NOT used at users's side - and thus should not be placed inside the distribution of JabRef. I could not came up with a better name than misc 😅

Does this directory exist? jablib/src/misc/ does not exist even after updating my branch with the latest.

You will need to create it.

…to ktooltip

JustinHennis1 · 2025-05-20T02:53:39Z

@koppor I believe I fixed everything from what we've discussed.

trag-bot · 2025-05-27T00:26:07Z

@trag-bot didn't find any issues in the code! ✅✨

koppor

Looks good - I think, more things can be added follow-up

I am not sure if we should move the conversion to a real formatter -- the idea of the formatters is exactly that what the the current code does.

I know the UX is bad for the formatters, but with the current implementation, the UI gets even more cluttered.

In other words: The contents in "Miscellaneous" are working multi-field, whereas "field formatters" work single field

JustinHennis1 · 2025-05-27T14:23:00Z

The original feature/issue requested a cleanup or button. I can look into this over the coming weekend.On May 27, 2025, at 1:22 AM, Oliver Kopp ***@***.***> wrote: @koppor requested changes on this pull request. Looks good - I think, more things can be added follow-up I am not sure if we should move the conversion to a real formatter -- the idea of the formatters is exactly that what the the current code does. I know the UX is bad for the formatters, but with the current implementation, the UI gets even more cluttered. In other words: The contents in "Miscellaneous" are working multi-field, whereas "field formatters" work single field image.png (view on web) —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you modified the open/close state.Message ID: ***@***.***>

koppor · 2025-05-27T14:57:46Z

The original feature/issue requested a cleanup or button.

I found #12944 (comment). This talks about a button at the keyword field. Should be shown only if any of the keywords is an MSC keyword.

It also talked about a cleanup operation, which I commented using the screenshot 😅

Sorry that we did not unzip the text of that comment.

I can look into this over the coming weekend

Nice! Thank you in advance!

Siedlerchr

I think this is okay right now and we can do the reworking of the abbrev stuff in another follow up pr

koppor · 2025-06-02T20:54:29Z

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

+        // Add active jobs from preset panel
        for (CleanupPreferences.CleanupStep action : preset.getActiveJobs()) {
-            jobs.add(toJob(action));
+                jobs.add(toJob(action));
        }


Reads like AI-modified content.

--> indent is wrong and comment could be removed

Could also be done in a follow-up PR

koppor · 2025-06-02T20:58:00Z

I filed #13227. @JustinHennis1 You can take it or we hope that someone else takes it.

JustinHennis1 · 2025-06-02T23:01:20Z

I filed #13227. @JustinHennis1 You can take it or we hope that someone else takes it.

I have the FieldFormatter implemented locally, I just need to remove the cleanup and change the tests. Would the easiest way be to create a new fork on Github? I don't want to lose the changes I made.

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

koppor requested changes May 19, 2025

View reviewed changes

Update MscCodeUtils.java

454ff20

Co-authored-by: Oliver Kopp <[email protected]>

trag-bot bot reviewed May 19, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/util/MscCodeUtils.java Outdated Show resolved Hide resolved

koppor reviewed May 19, 2025

View reviewed changes

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

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

Merge branch 'main' into ktooltip

4899acd

JustinHennis1 and others added 4 commits May 19, 2025 20:13

Merge branch 'main' into ktooltip

4902616

Fixed Changes From Review#2

27edde8

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

4c6b2be

…to ktooltip

removed unnecessary file

3950b3d

Merge branch 'main' into ktooltip

99cb9d3

JustinHennis1 requested a review from koppor May 27, 2025 00:24

koppor requested changes May 27, 2025

View reviewed changes

Siedlerchr approved these changes Jun 2, 2025

View reviewed changes

koppor reviewed Jun 2, 2025

View reviewed changes

koppor mentioned this pull request Jun 2, 2025

Make ConvertMSCCodesCleanup a Formatter #13227

Closed

koppor enabled auto-merge June 2, 2025 20:57

koppor approved these changes Jun 2, 2025

View reviewed changes

koppor added this pull request to the merge queue Jun 2, 2025

Merged via the queue into JabRef:main with commit b309292 Jun 2, 2025
1 check passed

github-actions bot mentioned this pull request Jun 2, 2025

Add Mathematics Subject Classification as tooltip to keywords #12944

Closed

Uh oh!

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

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

Uh oh!

Conversation

JustinHennis1 commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ToolTip

Cleanup

Before:

After:

Mandatory checks

Uh oh!

Siedlerchr Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Siedlerchr commented Apr 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

koppor commented May 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JustinHennis1 commented May 19, 2025

Uh oh!

koppor commented May 19, 2025

Uh oh!

JustinHennis1 commented May 20, 2025

Uh oh!

trag-bot bot commented May 27, 2025

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

JustinHennis1 commented May 27, 2025 via email

Uh oh!

koppor commented May 27, 2025

Uh oh!

Siedlerchr left a comment

Choose a reason for hiding this comment

Uh oh!

koppor Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

koppor commented Jun 2, 2025

Uh oh!

Uh oh!

JustinHennis1 commented Jun 2, 2025

Uh oh!

Uh oh!

JustinHennis1 commented Apr 9, 2025 •

edited

Loading