Make Web Search 'Configure API key' searchable in preferences #13929 (#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

Author: OmkarNagare16

CHANGELOG.md

@@ -11,6 +11,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 
 ### Added
 
+- 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)
 - We added the integrity check to the jabkit cli application. [#13848](https://github.com/JabRef/jabref/issues/13848)
 - We added support for Cygwin-file paths on a Windows Operating System. [#13274](https://github.com/JabRef/jabref/issues/13274)
 - We fixed an issue where "Print preview" would throw a `NullPointerException` if no printers were available. [#13708](https://github.com/JabRef/jabref/issues/13708)

jabgui/src/main/java/org/jabref/gui/preferences/PreferencesSearchHandler.java

@@ -70,7 +70,8 @@ public void filterTabs(String query) {
      * @return True if the tab matches the query.
      */
     private boolean tabMatchesQuery(PreferencesTab tab, String query) {
-        boolean tabNameMatches = tab.getTabName().toLowerCase(Locale.ROOT).contains(query);
+        boolean tabNameMatches = tab.getSearchKeywords().stream()
+                                    .anyMatch(keyword -> keyword.toLowerCase(Locale.ROOT).contains(query));
 
         boolean controlMatches = preferenceTabsControls.get(tab).stream()
                                                        .filter(control -> controlMatchesQuery(control, query))

jabgui/src/main/java/org/jabref/gui/preferences/PreferencesTab.java

@@ -11,6 +11,10 @@
  */
 public interface PreferencesTab {
 
+    default List<String> getSearchKeywords() {
+        return List.of(getTabName());
+    }
+
     Node getBuilder();
 
     /**

jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java

@@ -1,5 +1,6 @@
 package org.jabref.gui.preferences.websearch;
 
+import java.util.List;
 import java.util.Optional;
 
 import javafx.beans.InvalidationListener;
@@ -56,6 +57,18 @@ public WebSearchTab(ReadOnlyBooleanProperty refAiEnabled) {
                   .load();
     }
 
+    @Override
+    public List<String> getSearchKeywords() {
+        return List.of(
+                getTabName(),
+                Localization.lang("Configure API key"),
+                Localization.lang("Custom API key"),
+                "api",
+                "api key",
+                "apikey"
+        );
+    }
+
     @Override
     public String getTabName() {
         return Localization.lang("Web search");

jablib/src/main/resources/l10n/JabRef_en.properties

@@ -2008,6 +2008,7 @@ JabRef\ cannot\ access\ the\ file\ because\ it\ is\ being\ used\ by\ another\ pr
 Remove\ line\ breaks=Remove line breaks
 Removes\ all\ line\ breaks\ in\ the\ field\ content.=Removes all line breaks in the field content.
 Web\ search\ fetchers=Web search fetchers
+Custom\ API\ key=Custom API key
 API\ Key\ for\ %0=API Key for %0
 Test\ connection=Test connection
 API\ Key=API Key