Skip to content

Conversation

@brandon-lau0
Copy link
Contributor

@brandon-lau0 brandon-lau0 commented May 20, 2025

Summary of Changes

This PR adds a new "Search Google Scholar" feature to JabRef, similar to the existing "Search ShortScience" functionality. The feature allows users to quickly search for a selected entry's title in Google Scholar directly from the main table's context menu. The search engines are moved under the "Search..." tab in the right click menu for better organization.
Screenshot 2025-05-30 at 4 01 57 PM

In addition, we make Google Scholar and Short Science links configurable in the Preferences tab, under a new section named "Search Engine URL Templates". One of the comments mentioned, in the issue, that "the URL should be configurable. Reason: We cannot maintain JabRef for all site URLs; and the list of sites might be oppionated." This allows users to customize their URL templates, such as adding additional query parameters like author or strings.

Screenshot 2025-05-30 at 3 54 02 PM

The following shows the link the user is directed to after clicking "Search Google Scholar".
Screenshot 2025-05-30 at 4 15 12 PM

Closes #12268.

Bullet Pointed List of Changes:

  • Added new search Google Scholar option
  • Moved search engines to a "Search" sub-menu in right click menu
  • Allow "Search Google Scholar" and "Search Short Science" URLs to be configurable in Preferences under the "Search Engine URL Templates" section

Collaborators

@lydia-yan @yoasaaa @brandon-lau0 @FlyJoanne

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.
@koppor
Copy link
Member

koppor commented May 20, 2025

Update following are wrong comments; the feature is about opening using the web browser

Please investigate org.jabref.logic.importer.fetcher.GoogleScholar and read on at https://devdocs.jabref.org/code-howtos/fetchers.html.

Also look at #7075

You can try to work on JabRef#695.

@koppor koppor changed the title feat: support searching via google scholar feat: support open reference at google scholar May 21, 2025
@jabref-machine
Copy link
Collaborator

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Checkstyle (pull_request)" and click on it.

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.

Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues, commit, and push.

@brandon-lau0 brandon-lau0 marked this pull request as ready for review May 30, 2025 23:48
Copy link
Member

@koppor koppor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small comment on the tests

(I currently don't have much time to dive into this PR, but wanted to give a little pice of work to move this PR forward)


@Test
void getShortScienceSearchURLEncodesSpecialCharacters() {
ImporterPreferences stubPreferences = new StubImporterPreferences();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typically, this is done with mock and when. See other classes. Can you try this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I removed the StubImporterPreferences and replaced it with mock.

@koppor
Copy link
Member

koppor commented Jun 5, 2025

@brandon-lau0 May I ask if you are going to continue to work on this? - There are merge conflicts to resolve and tests made properly. If not, it is allright for us; we can then ask another student to continue.

@brandon-lau0 brandon-lau0 force-pushed the configurable_external_search_features branch from 1b9bacd to 550796e Compare June 8, 2025 00:33
@brandon-lau0 brandon-lau0 force-pushed the configurable_external_search_features branch from 550796e to eade1cf Compare June 8, 2025 01:12
@brandon-lau0
Copy link
Contributor Author

@brandon-lau0 May I ask if you are going to continue to work on this? - There are merge conflicts to resolve and tests made properly. If not, it is allright for us; we can then ask another student to continue.

Thank you for your patience. I just resolved the merge conflicts and the tests to use mocks.

@koppor koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jul 7, 2025
@trag-bot
Copy link

trag-bot bot commented Jul 7, 2025

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

@jabref-machine
Copy link
Collaborator

JUnit tests of jablib are failing. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

Copy link
Collaborator

@Yubo-Cao Yubo-Cao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! I have tried out your PR, and basically everything works.

@koppor
Copy link
Member

koppor commented Jul 31, 2025

I like the idea of preferences; therefore, this PR should be continued.

@subhramit subhramit added status: changes-required Pull requests that are not yet complete and removed status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels Aug 4, 2025
@brandon-lau0
Copy link
Contributor Author

I like the idea of preferences; therefore, this PR should be continued.

Thank you for your feedback and for supporting the preferences feature! At this time, I won’t be able to continue working on this PR due to other commitments. I hope what I’ve done so far can serve as a useful starting point for further development. I appreciate the opportunity to contribute. Thank you!

@calixtus
Copy link
Member

calixtus commented Oct 9, 2025

Hey @Yubo-Cao , are you maybe interested in finalizing this PR? This is maybe a low hanging fruit. Would be great for the students who have worked on this to see, that this gets into the code.

@jabref-machine
Copy link
Collaborator

You ticked that you modified CHANGELOG.md, but no new entry was found there.

If you made changes that are visible to the user, please add a brief description along with the issue number to the CHANGELOG.md file. If you did not, please replace the cross ([x]) by a slash ([/]) to indicate that no CHANGELOG.md entry is necessary. More details can be found in our Developer Documentation about the changelog.

@jabref-machine
Copy link
Collaborator

Your code currently does not meet JabRef's code guidelines. IntelliJ auto format covers some cases. There seem to be issues with your code style and autoformat configuration. Please reformat your code (Ctrl+Alt+L) and commit, then push.

In special cases, consider using // formatter:off and // formatter:on annotations to allow deviation from the code style.

@subhramit subhramit force-pushed the configurable_external_search_features branch from d0c49e3 to 222812c Compare November 11, 2025 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: changes-required Pull requests that are not yet complete

6 participants