Show a welcome screen if no database is open #12461

oops-shlok · 2025-02-04T10:27:39Z

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.

Screen.Recording.2025-02-04.at.3.49.55.PM.mov

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

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.

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.

calixtus

Just a quick review from my cellphone. A more deeper look will follow.

src/main/java/org/jabref/gui/Base.css

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

src/main/java/org/jabref/gui/util/WelcomePage.java

oops-shlok · 2025-02-04T21:42:42Z

Hi @calixtus! Saw all the comments with respect to the PR. Will resolve them asap. Thanks for the review!

…issue-JabRef#12272

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.

subhramit

Hey @oops-shlok, thanks for your contribution!
Please revert the submodule changes (steps linked below).

Also, please don't resolve conversations from your end until the reviewer who asked for the change is satisfied and does that - otherwise each comment has to be manually expanded when trying to gather context on the changes asked (when re-reviewing) or to read your replies and carry the discussion forward.
For very trivial comments (for example, these ones below), you can mark resolved once done.

subhramit · 2025-02-05T21:21:47Z

buildres/abbrv.jabref.org

Undo the changes to submodules. Follow the alternative method in https://devdocs.jabref.org/code-howtos/faq.html#submodules

Noted. Will do this from now. Reverted the changes to submodules.

subhramit · 2025-02-05T21:22:11Z

src/main/resources/csl-styles

Same as above

Reverted the changes to submodules

koppor · 2025-02-06T12:41:34Z

src/main/java/org/jabref/gui/exporter/ExportCommand.java

+                                })),
+                                Duration.seconds(5));
+                    } else {
+                        LOGGER.warn("Library Tab is null as Welcome Tab is open");


This is not a warning.

Please store tabSupplier.get() in a variable. You can use the refacroing functionality of IntelliJ for that ("extract variable)

Just add a comment above the if to say that the tab is null in case of the welcome page.

koppor · 2025-02-06T12:45:05Z

src/main/java/org/jabref/gui/exporter/SaveDatabaseAction.java

+        if (libraryTab == null) {
+            return false;
+        }


This reads like a code smell...

The action has to be disabled if no tab is opened. -- work on the bindings.

executable.bind(needsDatabase(stateManager)); is the code search hint.

See other fixes for other cases: #12199

Maybe there is somewhere an instanceOf check missing where SaveDatabaseAction#save is called?

…issue-JabRef#12272

calixtus · 2025-02-06T19:32:55Z

src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java

        if (tabContainer.getLibraryTabs().isEmpty()) {
            return preferences.getFilePreferences().getWorkingDirectory();
-        } else {
-            Optional<Path> databasePath = tabContainer.getCurrentLibraryTab().getBibDatabaseContext().getDatabasePath();
-            return databasePath.map(Path::getParent).orElse(preferences.getFilePreferences().getWorkingDirectory());
        }
+
+        LibraryTab currentTab = tabContainer.getCurrentLibraryTab();
+        if (currentTab == null) {
+            return preferences.getFilePreferences().getWorkingDirectory();
+        }
+
+        Optional<Path> databasePath = currentTab.getBibDatabaseContext().getDatabasePath();
+        return databasePath.map(Path::getParent).orElse(preferences.getFilePreferences().getWorkingDirectory());


getLibraryTabs is not empty, but getCurrentLibraryTab could be null?

calixtus · 2025-02-06T19:33:18Z

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

+            fileHistory.setDisable(!hasRecentFiles);
+        });
+
+        this.welcomePage = new WelcomePage(


Why do you initialize this here? Just put all the WelcomePage stuff into the tab. You do not reuse the WelcomePage in JabRefFrame.

calixtus · 2025-02-06T19:36:50Z

src/main/java/org/jabref/gui/util/WelcomePage.java

+    private final TaskExecutor taskExecutor;
+    private final FileHistoryMenu fileHistoryMenu;
+
+    public WelcomePage(JabRefFrame frame,


Always use the smalles possible scope to avoid unneccessary dependencies.

Suggested change

public WelcomePage(JabRefFrame frame,

public WelcomePage(LibraryTabContainer tabContainer,

calixtus · 2025-02-06T19:38:16Z

src/main/java/org/jabref/gui/util/WelcomePage.java

+import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.model.util.FileUpdateMonitor;
+
+public class WelcomePage {


Integrate into WelcomeTab

calixtus · 2025-02-06T19:40:45Z

src/main/java/org/jabref/gui/exporter/SaveDatabaseAction.java

+        if (libraryTab == null) {
+            return false;
+        }


Maybe there is somewhere an instanceOf check missing where SaveDatabaseAction#save is called?

koppor · 2025-02-10T16:27:08Z

For reference, the current VSCode welcome screen offers walkthroughs: - Maybe as follow-up

…issue-JabRef#12272

src/main/java/org/jabref/gui/LibraryTab.java

koppor · 2025-02-14T07:38:27Z

src/main/java/org/jabref/gui/WelcomeTab.java

+                      TaskExecutor taskExecutor,
+                      FileHistoryMenu fileHistoryMenu) {
+
+        super("Welcome");


I think, there is a Localization missing?

koppor · 2025-02-14T07:38:43Z

src/main/java/org/jabref/gui/WelcomeTab.java

+        Label welcomeLabel = new Label(Localization.lang("Welcome to JabRef"));
+        welcomeLabel.getStyleClass().add("welcome-label");
+
+        Label descriptionLabel = new Label(Localization.lang("Stay on top of your Literature"));


Suggested change

Label descriptionLabel = new Label(Localization.lang("Stay on top of your Literature"));

Label descriptionLabel = new Label(Localization.lang("Stay on top of your literature"));

src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java

koppor · 2025-02-14T07:41:19Z

src/main/resources/l10n/JabRef_en.properties

@@ -2854,3 +2854,11 @@ Include=Include
 Exclude=Exclude
 Include\ or\ exclude\ cross-referenced\ entries=Include or exclude cross-referenced entries
 Would\ you\ like\ to\ include\ cross-reference\ entries\ in\ the\ current\ operation?=Would you like to include cross-reference entries in the current operation?
+
+New\ Library=New Library


Very strange that a new localization is needed.

Please rework the strings to be in line with the other casing in JabRef

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.

calixtus · 2025-02-14T13:58:54Z

Hi, I finally tested your changes in JabRef. I like it very much and I think its a great addition for new users with a big impact. I have two small suggestions from testing it:

The welcomeTab should only open, if there is not already another file opened from last time (check for OpenDatabases object in uiCommands).
Add a menu entry in help "open welcome tab".

Thanks!

src/main/java/org/jabref/gui/WelcomeTab.java

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

oops-shlok · 2025-03-19T19:11:30Z

@koppor Fixed the localisation issue. Anything else that needs to be changed?

…shlok/jabref into fix-for-issue-JabRef#12272

koppor · 2025-03-19T19:34:55Z

@oops-shlok I will finish the PR - I have time only today for a longer JabRef session - and I think, this back and forth is not worth our time. Time is better spend in new issues.

What I did

Consistency in language: Help menu should have same strings than in the welcome tab. @InAnYan We changed both strings to "Community forum now"
The welcome tab was shown if a file was opened. I fixed this by placing the call at a better place.

oops-shlok · 2025-03-19T19:37:06Z

@oops-shlok I will finish the PR - I have time only today for a longer JabRef session - and I think, this back and forth is not worth our time. Time is better spend in new issues.

What I did

Consistency in language: Help menu should have same strings than in the welcome tab. @InAnYan We changed both strings to "Community forum now"

The welcome tab was shown if a file was opened. I fixed this by placing the call at a better place.

Sure @koppor! I am also available now. You can lmk in case anything needs to be done.

trag-bot · 2025-03-19T20:01:08Z

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

koppor · 2025-03-19T20:34:01Z

Gui Tests are more fetcher tests - the remote seems to block - failing gui test is OK :)

obsolete

calixtus · 2025-03-19T21:40:46Z

Finally this pr is merged. @oops-shlok thanks for your addition. A great new feature for JabRef.

oops-shlok · 2025-03-19T21:47:43Z

Finally this pr is merged. @oops-shlok thanks for your addition. A great new feature for JabRef.

Thanks! It was great working on this feature. Will continue working on follow up PRs for this and also look into other issues. Thanks @calixtus and @koppor for the constant support.

Fix JabRef#12272 - Show a welcome screen if no database is open

08ec5d8

github-actions bot reviewed Feb 4, 2025

View reviewed changes

Fix JabRef#12272 - Fix missing localisation keys for WelcomePage

684f7df

github-actions bot reviewed Feb 4, 2025

View reviewed changes

Fix JabRef#12272 - Fix missing localisation keys for WelcomePage

3759e24

calixtus requested changes Feb 4, 2025

View reviewed changes

subhramit changed the title ~~Fix #12272 - Show a welcome screen if no database is open~~ Show a welcome screen if no database is open Feb 5, 2025

oops-shlok added 3 commits February 6, 2025 01:26

Merge branch 'main' of https://github.com/JabRef/jabref into fix-for-…

9fc595d

…issue-JabRef#12272

Fix JabRef#12272 - Addressed 1st Review Changes

4e576e9

Fix JabRef#12272 - Checkstyle issue fix in ExportCommand file

52409bd

github-actions bot reviewed Feb 5, 2025

View reviewed changes

oops-shlok requested a review from calixtus February 5, 2025 20:21

subhramit previously requested changes Feb 5, 2025

View reviewed changes

oops-shlok added 2 commits February 6, 2025 03:33

Reverted csl-styles submodule changes

f130244

Reverted abbrv.jabref.org submodule changes

2559f22

oops-shlok requested a review from subhramit February 5, 2025 22:09

koppor requested changes Feb 6, 2025

View reviewed changes

Merge branch 'main' of https://github.com/JabRef/jabref into fix-for-…

0d240c9

…issue-JabRef#12272

calixtus requested changes Feb 6, 2025

View reviewed changes

oops-shlok added 3 commits February 12, 2025 03:10

Merge branch 'main' of https://github.com/JabRef/jabref into fix-for-…

cb05ec7

…issue-JabRef#12272

Merge branch 'main' of https://github.com/JabRef/jabref into fix-for-…

0489da1

…issue-JabRef#12272

Integrated WelcomePage in WelcomeTab and code changes

669083d

oops-shlok requested review from koppor and calixtus February 13, 2025 17:38

koppor requested changes Feb 14, 2025

View reviewed changes

github-actions bot reviewed Feb 14, 2025

View reviewed changes

Implemented Review Changes 5

cf3188e

koppor reviewed Mar 19, 2025

View reviewed changes

src/main/java/org/jabref/gui/WelcomeTab.java Outdated Show resolved Hide resolved

Update src/main/java/org/jabref/gui/WelcomeTab.java

23891b6

koppor reviewed Mar 19, 2025

View reviewed changes

src/main/java/org/jabref/gui/frame/JabRefFrame.java Outdated Show resolved Hide resolved

koppor and others added 3 commits March 19, 2025 19:55

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

4bc74b6

Fixed Localization issue

0076919

Merge branch 'main' into fix-for-issue-JabRef#12272

a71d9fb

koppor added 3 commits March 19, 2025 20:22

Fix position of showing welcome tab

3c14ba8

Streamline wording

c94fb15

Merge branch 'fix-for-issue-JabRef#12272' of https://github.com/oops-…

c695f5b

…shlok/jabref into fix-for-issue-JabRef#12272

Remove obsolete strings

5115579

koppor added 2 commits March 19, 2025 20:45

Fix obsolete code

f7c0c3b

Fix comment

5d84d89

koppor enabled auto-merge March 19, 2025 19:54

calixtus previously approved these changes Mar 19, 2025

View reviewed changes

Fix localization

37e24d2

koppor dismissed calixtus’s stale review via 37e24d2 March 19, 2025 19:58

calixtus approved these changes Mar 19, 2025

View reviewed changes

koppor added this pull request to the merge queue Mar 19, 2025

Merged via the queue into JabRef:main with commit 84513f7 Mar 19, 2025
31 of 33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show a welcome screen if no database is open #12461

Show a welcome screen if no database is open #12461

oops-shlok commented Feb 4, 2025 •

edited

Loading

github-actions bot left a comment

github-actions bot left a comment

calixtus left a comment

oops-shlok commented Feb 4, 2025

github-actions bot left a comment

subhramit left a comment

subhramit Feb 5, 2025

oops-shlok Feb 5, 2025

subhramit Feb 5, 2025

oops-shlok Feb 5, 2025

koppor Feb 6, 2025

koppor Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

koppor commented Feb 10, 2025

koppor Feb 14, 2025

koppor Feb 14, 2025

koppor Feb 14, 2025

github-actions bot left a comment

calixtus commented Feb 14, 2025

oops-shlok commented Mar 19, 2025

koppor commented Mar 19, 2025

oops-shlok commented Mar 19, 2025

trag-bot bot commented Mar 19, 2025

koppor commented Mar 19, 2025

calixtus commented Mar 19, 2025

oops-shlok commented Mar 19, 2025

	public WelcomePage(JabRefFrame frame,
	public WelcomePage(LibraryTabContainer tabContainer,

	Label descriptionLabel = new Label(Localization.lang("Stay on top of your Literature"));
	Label descriptionLabel = new Label(Localization.lang("Stay on top of your literature"));

Show a welcome screen if no database is open #12461

Show a welcome screen if no database is open #12461

Conversation

oops-shlok commented Feb 4, 2025 • edited Loading

Mandatory checks

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

calixtus left a comment

Choose a reason for hiding this comment

oops-shlok commented Feb 4, 2025

github-actions bot left a comment

Choose a reason for hiding this comment

subhramit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koppor commented Feb 10, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

calixtus commented Feb 14, 2025

oops-shlok commented Mar 19, 2025

koppor commented Mar 19, 2025

oops-shlok commented Mar 19, 2025

trag-bot bot commented Mar 19, 2025

koppor commented Mar 19, 2025

calixtus commented Mar 19, 2025

oops-shlok commented Mar 19, 2025

oops-shlok commented Feb 4, 2025 •

edited

Loading