Add more walkthroughs, donation prompt, and responsive layout for welcome tab

CHANGELOG.md

@@ -73,6 +73,8 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We changed the validation error dialog for overriding the default file directories to a confirmation dialog for saving other preferences under the library properties. [#13488](https://github.com/JabRef/jabref/pull/13488)
 - We improved file exists warning dialog with clearer options and tooltips [#12565](https://github.com/JabRef/jabref/issues/12565)
 - We introduced walkthrough functionality [#12664](https://github.com/JabRef/jabref/issues/12664)
+- The Welcome tab now has a responsive layout. [#12664](https://github.com/JabRef/jabref/issues/12664)
+- We introduced a donation prompt in the Welcome tab. [#12664](https://github.com/JabRef/jabref/issues/12664)
 
 ### Fixed
 

jabgui/src/main/java/org/jabref/gui/frame/JabRefFrame.java

@@ -48,6 +48,7 @@
 import org.jabref.gui.search.SearchType;
 import org.jabref.gui.sidepane.SidePane;
 import org.jabref.gui.sidepane.SidePaneType;
+import org.jabref.gui.theme.ThemeManager;
 import org.jabref.gui.undo.CountingUndoManager;
 import org.jabref.gui.undo.RedoAction;
 import org.jabref.gui.undo.UndoAction;
@@ -447,7 +448,8 @@ private void initBindings() {
     }
 
     private void updateTabBarVisible() {
-        if (preferences.getWorkspacePreferences().shouldHideTabBar() && stateManager.getOpenDatabases().size() <= 1) {
+        // When WelcomeTab is open, the tabbar should be visible
+        if (preferences.getWorkspacePreferences().shouldHideTabBar() && tabbedPane.getTabs().size() <= 1) {
             if (!tabbedPane.getStyleClass().contains("hide-tab-bar")) {
                 tabbedPane.getStyleClass().add("hide-tab-bar");
             }
@@ -507,7 +509,9 @@ public void showWelcomeTab() {
                 clipBoardManager,
                 taskExecutor,
                 fileHistory,
-                Injector.instantiateModelOrService(BuildInfo.class)
+                Injector.instantiateModelOrService(BuildInfo.class),
+                preferences.getWorkspacePreferences(),
+                Injector.instantiateModelOrService(ThemeManager.class)
         );
         tabbedPane.getTabs().add(welcomeTab);
         tabbedPane.getSelectionModel().select(welcomeTab);

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

@@ -0,0 +1,40 @@
+package org.jabref.gui.preferences;
+
+import javafx.beans.property.BooleanProperty;
+import javafx.beans.property.IntegerProperty;
+import javafx.beans.property.SimpleBooleanProperty;
+import javafx.beans.property.SimpleIntegerProperty;
+
+public class DonationPreferences {
+    private final BooleanProperty neverShowAgain = new SimpleBooleanProperty();
+    private final IntegerProperty lastShownEpochDay = new SimpleIntegerProperty();
+
+    public DonationPreferences(boolean neverShowAgain, int lastShownEpochDay) {
+        this.neverShowAgain.set(neverShowAgain);
+        this.lastShownEpochDay.set(lastShownEpochDay);
+    }
+
+    public boolean isNeverShowAgain() {
+        return neverShowAgain.get();
+    }
+
+    public void setNeverShowAgain(boolean value) {
+        this.neverShowAgain.set(value);
+    }
+
+    public BooleanProperty neverShowAgainProperty() {
+        return neverShowAgain;
+    }
+
+    public int getLastShownEpochDay() {
+        return lastShownEpochDay.get();
+    }
+
+    public void setLastShownEpochDay(int value) {
+        this.lastShownEpochDay.set(value);
+    }
+
+    public IntegerProperty lastShownEpochDayProperty() {
+        return lastShownEpochDay;
+    }
+}

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

@@ -58,4 +58,6 @@ public interface GuiPreferences extends CliPreferences {
     KeyBindingRepository getKeyBindingRepository();
 
     NewEntryPreferences getNewEntryPreferences();
+
+    DonationPreferences getDonationPreferences();
 }

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

@@ -204,6 +204,11 @@ public class JabRefGuiPreferences extends JabRefCliPreferences implements GuiPre
     private static final String INCLUDE_CROSS_REFERENCES = "includeCrossReferences";
     private static final String ASK_FOR_INCLUDING_CROSS_REFERENCES = "askForIncludingCrossReferences";
 
+    // region Donation preferences
+    private static final String DONATION_NEVER_SHOW = "donationNeverShow";
+    private static final String DONATION_LAST_SHOWN_EPOCH_DAY = "donationLastShownEpochDay";
+    // endregion
+
     // region NewEntryPreferences
     private static final String CREATE_ENTRY_APPROACH = "latestApproach";
     private static final String CREATE_ENTRY_EXPAND_RECOMMENDED = "typesRecommendedExpanded";
@@ -236,6 +241,7 @@ public class JabRefGuiPreferences extends JabRefCliPreferences implements GuiPre
     private KeyBindingRepository keyBindingRepository;
     private CopyToPreferences copyToPreferences;
     private NewEntryPreferences newEntryPreferences;
+    private DonationPreferences donationPreferences;
 
     private JabRefGuiPreferences() {
         super();
@@ -378,6 +384,11 @@ private JabRefGuiPreferences() {
         defaults.put(ASK_FOR_INCLUDING_CROSS_REFERENCES, Boolean.TRUE);
         defaults.put(INCLUDE_CROSS_REFERENCES, Boolean.FALSE);
 
+        // region donation defaults
+        defaults.put(DONATION_NEVER_SHOW, Boolean.FALSE);
+        defaults.put(DONATION_LAST_SHOWN_EPOCH_DAY, -1);
+        // endregion
+
         // region NewEntryUnifierPreferences
         defaults.put(CREATE_ENTRY_APPROACH, List.of(NewEntryDialogTab.values()).indexOf(NewEntryDialogTab.CHOOSE_ENTRY_TYPE));
         defaults.put(CREATE_ENTRY_EXPAND_RECOMMENDED, true);
@@ -1192,6 +1203,17 @@ public NewEntryPreferences getNewEntryPreferences() {
         return newEntryPreferences;
     }
 
+    public DonationPreferences getDonationPreferences() {
+        if (donationPreferences != null) {
+            return donationPreferences;
+        }
+
+        donationPreferences = new DonationPreferences(getBoolean(DONATION_NEVER_SHOW), getInt(DONATION_LAST_SHOWN_EPOCH_DAY));
+        EasyBind.listen(donationPreferences.neverShowAgainProperty(), (_, _, newValue) -> putBoolean(DONATION_NEVER_SHOW, newValue));
+        EasyBind.listen(donationPreferences.lastShownEpochDayProperty(), (_, _, newValue) -> putInt(DONATION_LAST_SHOWN_EPOCH_DAY, newValue.intValue()));
+        return donationPreferences;
+    }
+
     /**
      * In GUI mode, we can lookup the directory better
      */

jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTab.java

@@ -49,6 +49,7 @@ public class GeneralTab extends AbstractPreferenceTabView<GeneralTabViewModel> i
     @FXML private CheckBox confirmDelete;
     @FXML private CheckBox shouldAskForIncludingCrossReferences;
     @FXML private CheckBox confirmHideTabBar;
+    @FXML private CheckBox donationNeverShow;
     @FXML private ComboBox<BibDatabaseMode> biblatexMode;
     @FXML private CheckBox alwaysReformatBib;
     @FXML private CheckBox autosaveLocalLibraries;
@@ -125,6 +126,7 @@ public void initialize() {
         confirmDelete.selectedProperty().bindBidirectional(viewModel.confirmDeleteProperty());
         shouldAskForIncludingCrossReferences.selectedProperty().bindBidirectional(viewModel.shouldAskForIncludingCrossReferences());
         confirmHideTabBar.selectedProperty().bindBidirectional(viewModel.confirmHideTabBarProperty());
+        donationNeverShow.selectedProperty().bindBidirectional(viewModel.donationNeverShowProperty());
 
         new ViewModelListCellFactory<BibDatabaseMode>()
                 .withText(BibDatabaseMode::getFormattedName)

jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java

@@ -84,6 +84,7 @@ public class GeneralTabViewModel implements PreferenceTabViewModel {
     private final BooleanProperty confirmDeleteProperty = new SimpleBooleanProperty();
     private final BooleanProperty shouldAskForIncludingCrossReferencesProperty = new SimpleBooleanProperty();
     private final BooleanProperty hideTabBarProperty = new SimpleBooleanProperty();
+    private final BooleanProperty donationNeverShowProperty = new SimpleBooleanProperty();
 
     private final ListProperty<BibDatabaseMode> bibliographyModeListProperty = new SimpleListProperty<>();
     private final ObjectProperty<BibDatabaseMode> selectedBiblatexModeProperty = new SimpleObjectProperty<>();
@@ -210,6 +211,7 @@ public void setValues() {
         confirmDeleteProperty.setValue(workspacePreferences.shouldConfirmDelete());
         shouldAskForIncludingCrossReferencesProperty.setValue(preferences.getCopyToPreferences().getShouldAskForIncludingCrossReferences());
         hideTabBarProperty.setValue(workspacePreferences.shouldHideTabBar());
+        donationNeverShowProperty.setValue(preferences.getDonationPreferences().isNeverShowAgain());
 
         bibliographyModeListProperty.setValue(FXCollections.observableArrayList(BibDatabaseMode.values()));
         selectedBiblatexModeProperty.setValue(libraryPreferences.getDefaultBibDatabaseMode());
@@ -256,6 +258,7 @@ public void storeSettings() {
         workspacePreferences.setConfirmDelete(confirmDeleteProperty.getValue());
         preferences.getCopyToPreferences().setShouldAskForIncludingCrossReferences(shouldAskForIncludingCrossReferencesProperty.getValue());
         workspacePreferences.setHideTabBar(confirmHideTabBarProperty().getValue());
+        preferences.getDonationPreferences().setNeverShowAgain(donationNeverShowProperty.getValue());
 
         libraryPreferences.setDefaultBibDatabaseMode(selectedBiblatexModeProperty.getValue());
 
@@ -423,6 +426,10 @@ public BooleanProperty confirmHideTabBarProperty() {
         return this.hideTabBarProperty;
     }
 
+    public BooleanProperty donationNeverShowProperty() {
+        return this.donationNeverShowProperty;
+    }
+
     public ListProperty<BibDatabaseMode> biblatexModeListProperty() {
         return this.bibliographyModeListProperty;
     }

jabgui/src/main/java/org/jabref/gui/search/GlobalSearchBar.java

@@ -278,7 +278,14 @@ private void initSearchModifierButtons() {
         regexButton.setSelected(searchPreferences.isRegularExpression());
         regexButton.setTooltip(new Tooltip(Localization.lang("Regular expression") + "\n" + Localization.lang("This only affects unfielded terms. For using RegEx in a fielded term, use =~ operator.")));
         initSearchModifierButton(regexButton);
-        regexButton.setOnAction(event -> {
+        searchPreferences.getObservableSearchFlags().addListener((SetChangeListener<SearchFlags>) change -> {
+            if (change.wasAdded() && change.getElementAdded() == SearchFlags.REGULAR_EXPRESSION) {
+                regexButton.setSelected(true);
+            } else if (change.wasRemoved() && change.getElementRemoved() == SearchFlags.REGULAR_EXPRESSION) {
+                regexButton.setSelected(false);
+            }
+        });
+        regexButton.setOnAction(_ -> {
             searchPreferences.setSearchFlag(SearchFlags.REGULAR_EXPRESSION, regexButton.isSelected());
             searchField.requestFocus();
             updateSearchQuery();
@@ -287,7 +294,14 @@ private void initSearchModifierButtons() {
         caseSensitiveButton.setSelected(searchPreferences.isCaseSensitive());
         caseSensitiveButton.setTooltip(new Tooltip(Localization.lang("Case sensitive") + "\n" + Localization.lang("This only affects unfielded terms. For using case-sensitive in a fielded term, use =! operator.")));
         initSearchModifierButton(caseSensitiveButton);
-        caseSensitiveButton.setOnAction(event -> {
+        searchPreferences.getObservableSearchFlags().addListener((SetChangeListener<SearchFlags>) change -> {
+            if (change.wasAdded() && change.getElementAdded() == SearchFlags.CASE_SENSITIVE) {
+                caseSensitiveButton.setSelected(true);
+            } else if (change.wasRemoved() && change.getElementRemoved() == SearchFlags.CASE_SENSITIVE) {
+                caseSensitiveButton.setSelected(false);
+            }
+        });
+        caseSensitiveButton.setOnAction(_ -> {
             searchPreferences.setSearchFlag(SearchFlags.CASE_SENSITIVE, caseSensitiveButton.isSelected());
             searchField.requestFocus();
             updateSearchQuery();
@@ -296,15 +310,17 @@ private void initSearchModifierButtons() {
         keepSearchString.setSelected(searchPreferences.shouldKeepSearchString());
         keepSearchString.setTooltip(new Tooltip(Localization.lang("Keep search string across libraries")));
         initSearchModifierButton(keepSearchString);
-        keepSearchString.selectedProperty().addListener((obs, oldVal, newVal) -> {
+        searchPreferences.keepSearchStringProperty().addListener((_, _, newVal) -> keepSearchString.setSelected(newVal));
+        keepSearchString.selectedProperty().addListener((_, _, newVal) -> {
             searchPreferences.setKeepSearchString(newVal);
             searchField.requestFocus();
         });
 
         filterModeButton.setSelected(searchPreferences.getSearchDisplayMode() == SearchDisplayMode.FILTER);
         filterModeButton.setTooltip(new Tooltip(Localization.lang("Filter search results")));
         initSearchModifierButton(filterModeButton);
-        filterModeButton.setOnAction(event -> {
+        searchPreferences.searchDisplayModeProperty().addListener((_, _, newVal) -> filterModeButton.setSelected(newVal == SearchDisplayMode.FILTER));
+        filterModeButton.setOnAction(_ -> {
             searchPreferences.setSearchDisplayMode(filterModeButton.isSelected() ? SearchDisplayMode.FILTER : SearchDisplayMode.FLOAT);
             searchField.requestFocus();
         });

jabgui/src/main/java/org/jabref/gui/util/URLs.java

@@ -23,6 +23,14 @@ public class URLs {
     public static final String GROBID_DOC = "https://docs.jabref.org/collect/newentryfromplaintext#grobid";
     public static final String ENTRY_TABLE_COLUMNS_DOC = "https://docs.jabref.org/advanced/main-window";
 
+    // Walkthroughs URLs
+    public static final String GROUPS_DOC = "https://docs.jabref.org/finding-sorting-and-cleaning-entries/groups";
+    public static final String SEARCH_WITH_IN_LIBRARY_DOC = "https://docs.jabref.org/finding-sorting-and-cleaning-entries/search";
+    public static final String MANAGE_ASSOCIATED_FILES_DOC = "https://docs.jabref.org/finding-sorting-and-cleaning-entries/filelinks";
+    public static final String LINK_EXTERNAL_FILE_WALKTHROUGH_EXAMPLE_PDF = "https://nutritionandmetabolism.biomedcentral.com/counter/pdf/10.1186/1743-7075-3-2.pdf";
+    public static final String ADD_PDF_DOC = "https://docs.jabref.org/collect/add-pdfs-to-an-entry";
+    public static final String FIND_UNLINKED_FILES_DOC = "https://docs.jabref.org/collect/findunlinkedfiles";
+
     // AboutDialogViewModel URLs
     public static final String HOMEPAGE_URL = "https://www.jabref.org";
     public static final String DONATION_URL = "https://donations.jabref.org";