Add drop down for citation key patterns by priyanshu16095 · Pull Request #12516 · JabRef/jabref

priyanshu16095 · 2025-02-16T21:06:45Z

Fixes #12502

This PR introduces a functionality to display a drop-down list of matching suggestions when typing a citation key pattern.

Mandatory checks

I own the copyright of the code submitted and I licence 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 (for UI changes)
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.

koppor · 2025-02-16T22:02:47Z

Screenshot?

priyanshu16095 · 2025-02-16T22:06:54Z

Recording.2025-02-16.mp4

The positioning of list is not perfect, it comes on top of it, else works fine and the list of patterns is hardcoded.

subhramit

I know it's a draft, but requesting a minor change.
Really good work so far! Thanks for picking this up.

priyanshu16095 · 2025-02-17T22:34:47Z

Recording.2025-02-18.mp4

For CitationKeyPatternSuggestionCell, I found this solution on Stack Overflow and a similar gist on Github Gist and modified it.

github-actions

Your code currently does not meet JabRef's code guidelines. We use OpenRewrite to ensure "modern" Java coding practices. The issues found can be automatically fixed. Please execute the gradle task rewriteRun, check the results, commit, and push.
You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".

github-actions

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues.
In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

priyanshu16095 · 2025-02-18T04:03:44Z

There is a problem with using the context menu because when it reaches the bottom of the screen, it shifts upward, making the UI buggy.
Instead, we can use a VBox or any other suggestions?

koppor · 2025-02-18T11:09:51Z

There is a problem with using the context menu because when it reaches the bottom of the screen, it shifts upward, making the UI buggy. Instead, we can use a VBox or any other suggestions?

If you don't get an answer quickly, just assume that nobody has a clue and will need invest time to investigate. Thus, go ahead and try.

Note that we could accept a different UI using a popup and buttons -similar to "Select entry type" -- if this works better

With this, we could even recommend certain citation key paterns.

priyanshu16095 · 2025-02-20T19:04:40Z

The feature is now complete.
For the last element, it works fine, and the context menu does not change its position.

Co-authored-by: Subhramit Basu Bhowmick <subhramit.bb@live.in>

subhramit · 2025-02-20T20:35:54Z

+
+        private void populatePopup(List<String> searchResult) {
+            List<CustomMenuItem> menuItems = new ArrayList<>();
+            int maxEntries = 7;


Move this to a class-level constant with a brief comment explaining its use and the value

subhramit

Tested it, works fine.
Code-wise too I can see everything I asked for.

Someone a bit deeper into javafx should take a closer look at the gui files.

priyanshu16095 · 2025-02-21T09:18:41Z

I found this solution on Stack Overflow for GUI.

subhramit · 2025-02-21T09:22:11Z

Update - tested a case - in case of compound patterns like [auth]_[year], however, the dropdown doesn't come except when typing the first [auth].
See comment #12502 (comment).
If this is possible to do, that would complete it, else too I guess it's better than not having it so I keep my approval.

priyanshu16095 · 2025-02-21T09:42:45Z

Will do. I'll ensure [auth]_[year] triggers the dropdown.

priyanshu16095 · 2025-02-21T12:27:12Z

This pattern [auth]_[year] does not exist in the Java record.

github-actions

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues.
In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

Siedlerchr · 2025-02-21T20:04:46Z

Wow this is a really epic feature! Looks great!

Siedlerchr · 2025-02-21T20:05:52Z

Please add a changelog entry!

subhramit · 2025-02-21T20:58:30Z

This pattern [auth]_[year] does not exist in the Java record.

Yes, it is not supposed to, it is a compound pattern - what I meant was (as per #12502 (comment)) - the individual components of a compound pattern should trigger a dropdown. I have given an example. [auth] triggering a dropdown (as matches exist), _ not (as no matches) and [year] again individually triggering a matching dropdown, treating it as running text.

I like your solution more though, and hardcoding it into the record works as it's a common pattern. Any less used pattern can be manually typed anyway. The sub-dropdowns are an icing on the cake, so really good work. JabRef users will love this.

priyanshu16095 · 2025-02-21T21:19:56Z

Thanks for the clarification! I will try it in a follow-up PR.

subhramit · 2025-02-21T21:51:26Z

Thanks for the clarification! I will try it in a follow-up PR.

Not a priority right now, maybe when you can't find things more striking to work on.

Also, to clarify:

The sub-dropdowns are an icing on the cake, so really good work. JabRef users will love this.

I was referring to what you did, not what is left :)

koppor · 2025-02-26T10:49:57Z

+Author\ related=Author related
+Editor\ related=Editor related
+Title\ related=Title related
+BibEntry\ fields=BibEntry fields


@priyanshu16095 I totally overlooked the last entry while reviewing. (Nearly) all other translations use "entry" only.

Can you file a full-up PR replacing "BibEntry" by "Entry"/"entry"? (I found two hits in the language file)

Add a suggestions text field

1618eec

subhramit requested changes Feb 16, 2025

View reviewed changes

Comment thread src/main/java/org/jabref/gui/commonfxcontrols/CitationKeyPatternsPanel.java Outdated

Improve text field and make use of CitationKeyPattern record

7597467

github-actions Bot reviewed Feb 17, 2025

View reviewed changes

priyanshu16095 added 4 commits February 18, 2025 04:37

Fix the check

1b819f9

Change a comment

b8527aa

Make the fields private

88965e9

Make remaining fields private

40ce160

github-actions Bot reviewed Feb 17, 2025

View reviewed changes

priyanshu16095 added 2 commits February 18, 2025 05:12

Fix the check

948a495

Make fields public again

b874dfd

Fix the UI issue

fac8fbc

subhramit marked this pull request as ready for review February 20, 2025 19:19

subhramit requested changes Feb 20, 2025

View reviewed changes

Comment thread src/main/java/org/jabref/logic/citationkeypattern/CitationKeyPattern.java Outdated

Update CitationKeyPattern.java

7a61dad

Co-authored-by: Subhramit Basu Bhowmick <subhramit.bb@live.in>

subhramit added status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers component: citationkey-generator labels Feb 20, 2025

subhramit reviewed Feb 20, 2025

View reviewed changes

Define the MAX_ENTRIES variable

ed42bcc

subhramit previously approved these changes Feb 21, 2025

View reviewed changes

Merge branch 'main' into addDropdown

43292ba

priyanshu16095 added 3 commits February 21, 2025 18:13

Add submenu and improve suggestions

249229b

Add pattern in Java record

4dff9f2

Fix the check

10522b4

github-actions Bot reviewed Feb 21, 2025

View reviewed changes

Add setOnAction on menu item

58ef2f4

Siedlerchr previously approved these changes Feb 21, 2025

View reviewed changes

Siedlerchr added this pull request to the merge queue Feb 21, 2025

Siedlerchr removed this pull request from the merge queue due to a manual request Feb 21, 2025

Add a CHANGELOG.md entry

539c1fd

priyanshu16095 dismissed Siedlerchr’s stale review via 539c1fd February 21, 2025 20:08

Fix the issue

6f235c9

Siedlerchr previously approved these changes Feb 21, 2025

View reviewed changes

Siedlerchr enabled auto-merge February 21, 2025 20:13

Add keys in JabRef_en.properties

353f1bd

auto-merge was automatically disabled February 21, 2025 20:15
Head branch was pushed to by a user without write access

priyanshu16095 dismissed Siedlerchr’s stale review via 353f1bd February 21, 2025 20:15

Siedlerchr approved these changes Feb 21, 2025

View reviewed changes

Siedlerchr added this pull request to the merge queue Feb 21, 2025

Merged via the queue into JabRef:main with commit 4401efd Feb 21, 2025

priyanshu16095 mentioned this pull request Feb 22, 2025

Fix Citationkey pattern dropdown UI issue #12539

Merged

7 tasks

koppor reviewed Feb 26, 2025

View reviewed changes

This was referenced Feb 26, 2025

Replace "BibEntry" with "Entry" or "entry" in the language file #12579

Merged

Show compound patterns in the dropdown for citation key patterns #12580

Closed

Uh oh!

Conversation

priyanshu16095 commented Feb 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fixes #12502

Mandatory checks

Uh oh!

koppor commented Feb 16, 2025

Uh oh!

priyanshu16095 commented Feb 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhramit left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

priyanshu16095 commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

priyanshu16095 commented Feb 18, 2025

Uh oh!

koppor commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

priyanshu16095 commented Feb 20, 2025

Uh oh!

Uh oh!

subhramit Feb 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

subhramit left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

priyanshu16095 commented Feb 21, 2025

Uh oh!

subhramit commented Feb 21, 2025

Uh oh!

priyanshu16095 commented Feb 21, 2025

Uh oh!

priyanshu16095 commented Feb 21, 2025

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Siedlerchr commented Feb 21, 2025

Uh oh!

Uh oh!

Siedlerchr commented Feb 21, 2025

Uh oh!

subhramit commented Feb 21, 2025

Uh oh!

priyanshu16095 commented Feb 21, 2025

Uh oh!

subhramit commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

koppor Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

priyanshu16095 Feb 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

priyanshu16095 commented Feb 16, 2025 •

edited

Loading

priyanshu16095 commented Feb 16, 2025 •

edited

Loading

priyanshu16095 commented Feb 17, 2025 •

edited

Loading

koppor commented Feb 18, 2025 •

edited

Loading

subhramit Feb 20, 2025 •

edited

Loading

subhramit left a comment •

edited

Loading

subhramit commented Feb 21, 2025 •

edited

Loading

koppor Feb 26, 2025 •

edited

Loading