Skip to content

Conversation

@OmkarNagare16
Copy link
Contributor

@OmkarNagare16 OmkarNagare16 commented Sep 27, 2025

Closes #13929

This PR adds the ability to search for the "Configure API key" option in the Web Search preferences tab

Changes

  • Updated WebSearchTab.java to add search keywords such as "Configure API key", "Custom API key", "api", "api key", "apikey"
  • Updated PreferencesTab.java to include a default getSearchKeywords() method
  • Modified PreferencesSearchHandler.java to consider keywords when filtering tabs

With this change, users can quickly find the "Configure API key" option by typing relevant search terms in the preferences search bar

Steps to Test

  1. Open JabRef
  2. Go to Preferences → Web Search tab
  3. In the search bar at the top of Preferences, type any of the following:
    • "Configure API key"
    • "Custom API key"
    • "api"
    • "api key"
  4. Verify that the Web Search tab is highlighted as a search result

Visual Reference

Web Search Preferences

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • I manually tested my changes in running JabRef
  • I described the change in CHANGELOG.md
  • I added screenshots in the PR description (if change is visible to the user)
  • I added JUnit tests for changes (if applicable)
  • I checked the user documentation: Is the information available and up to date?

@github-actions
Copy link
Contributor

Hey @OmkarNagare16!

Thank you for contributing to JabRef! Your help is truly appreciated ❤️.

We have automatic checks in place, based on which you will soon get automated feedback if any of them are failing.
We also use TragBot with custom rules that scans your changes and provides some preliminary comments, before a maintainer takes a look.
TragBot is still learning, and may not always be accurate.
In the "Files changed" tab, you can go through its comments and just click on "Resolve conversation" if you are sure that it is incorrect, or comment on the conversation if you are doubtful.

Please re-check our contribution guide in case of any other doubts related to our contribution workflow.

@OmkarNagare16 OmkarNagare16 changed the title Make Web Search 'Configure API key' searchable in preferences Make Web Search 'Configure API key' searchable in preferences #13929 Sep 27, 2025
@OmkarNagare16 OmkarNagare16 changed the title Make Web Search 'Configure API key' searchable in preferences #13929 Make Web Search 'Configure API key' searchable in preferences #13929 Sep 27, 2025
@OmkarNagare16 OmkarNagare16 changed the title Make Web Search 'Configure API key' searchable in preferences #13929 Make Web Search 'Configure API key' searchable in preferences #13929 Sep 27, 2025
@Siedlerchr
Copy link
Member

lgtm, just add a changelog entry and it's good to go.
For future: You don't need to ping us when you create a PR, we will see it and will review when we have time for it. We all work on our free time in JabRef. So please be patient

@Siedlerchr Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Sep 27, 2025
CHANGELOG.md Outdated

### Added

- Made "Configure API key" option in the Web Search preferences tab searchable via preferences search. [#13929](https://github.com/JabRef/jabref/issues/13929)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Made "Configure API key" option in the Web Search preferences tab searchable via preferences search. [#13929](https://github.com/JabRef/jabref/issues/13929)
- We made the "Configure API key" option in the Web Search preferences tab searchable via preferences search. [#13929](https://github.com/JabRef/jabref/issues/13929)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @subhramit , I’ve just updated the changelog as suggested. Thanks for the review! Please let me know if there’s anything else.

@trag-bot
Copy link

trag-bot bot commented Sep 28, 2025

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

@Siedlerchr Siedlerchr added this pull request to the merge queue Sep 28, 2025
Merged via the queue into JabRef:main with commit 89316e6 Sep 28, 2025
51 checks passed
merlinymy pushed a commit to merlinymy/jabref that referenced this pull request Oct 6, 2025
…13929 (JabRef#13982)

* Make Web Search 'Configure API key' searchable in preferences

* Fix Checkstyle empty line issues in PreferencesTab and WebSearchTab

* Trigger CI after updating PR description

* Fix failing LocalizationConsistencyTest: add missing 'Custom API key' entry

* Add changelog entry for searchable API key preferences

* Fix list formatting in changelog

* Move changelog entry to Unreleased section

* Trigger CI

* Update changelog wording based on reviewer suggestion
Shanaya-1981 pushed a commit to Shanaya-1981/jabref that referenced this pull request Oct 13, 2025
…13929 (JabRef#13982)

* Make Web Search 'Configure API key' searchable in preferences

* Fix Checkstyle empty line issues in PreferencesTab and WebSearchTab

* Trigger CI after updating PR description

* Fix failing LocalizationConsistencyTest: add missing 'Custom API key' entry

* Add changelog entry for searchable API key preferences

* Fix list formatting in changelog

* Move changelog entry to Unreleased section

* Trigger CI

* Update changelog wording based on reviewer suggestion
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

first contrib status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make "Configure API key" discoverable when searching preferences

3 participants