Show a welcome screen if no database is open

[tobiasdiez]

JabRef looks really naked If no database is opened. Instead one could display a nice picture (of what?) and a message inviting the user to open/create a database.

[koppor]

Maybe we can bring back the image of our splash screen somehow (#89)? The splash screen was liked by some users: #360

Possibly, an example library should be displayed with some example entries and example groups to show the power of JabRef?

[simonharrer]

Atom cycles through tips/tricks when no file is opened. This is really nice.

I think we do not need the splash screen again.

[oscargus]

Tips and tricks would be very nice! There are so many features of JabRef that people are not aware of (which recent emails clearly have shown).

[matthiasgeiger]

Or something like this:

[simonharrer]

👍

[calixtus]

https://stackoverflow.com/questions/35239420/display-label-if-tabpane-has-no-tabs

[koppor]

It should be possible to create an example data base:

For new users, an example lib would be good. It should be named example.bib and showing some features. Maybe a howto. Showing groups etc.

(old issue: https://github.com/koppor/jabref/issues/374)

[calixtus]

complex.bib from testresources?

[koppor]

Offered default preferences:

• I am a "I don't care user" and want all cool features activated
• I am a pro-user wanting to manage BibTeX files only and thus do not want JabRef to do fancy stuff (reefs Deactivate fulltextsearch as default #9491)

[koppor]

Welcome screen if no library is open

(might happen if all libraries are closed and JabRef restarted)

It is not the same, something leightweight (see below)

Is this same-same as walkthrough? No, we remove preferences setting ("full text search", "include telemetry", ... ) after first close.

Welcome walkthrough

Welcome "screen" on first start (after installation) showing features, offering sensible defaults, ...

[tobiasdiez]

Please don't put too much information on the welcome screen. It should help people getting started (first users) or provide shortcuts to the most commonly used features (existing users).

As a datapoint (verified by user research as described in microsoft/vscode#63152), VS code moved from the busy old version

to the more minimal new page

I would argue that for us the simple "Open / create library" plus a list of recent libraries is sufficient as well. Maybe add a link to our docs, since our user interface is definitely not as self explanatory as the one of vscode.

For new users, VScode has a nice walkthrough but I don't see us implementing something like this soon (given our manpower, but maybe this would be a nice gsoc project?):

[koppor]

With "Welcome screen on first start (after installation)", I meant the "walkthrough" by VS.Code. I had a single page in mind, but a walkthrough is better, because of the different areas we cover. A quick implementation could have it on one page though.

For the walkthrough, we IMHO need experienced JabRef users, to really cover all features.

I move this discussion to another place to focus here on the "welcome screen"

[koppor]

Also think of the empty database case

However, this is handled at JabRef#384.

[u7229988-Rabie]

Hi, I am a first-time contributor, can I be assigned to this issue? I am a university student whose assignment requires me to contribute to open-source projects.

[koppor]

@u7229988-Rabie Yes, go ahead. Do that what tobias suggested at https://github.com/koppor/jabref/issues/96#issuecomment-1369502257

I would argue that for us the simple "Open / create library" plus a list of recent libraries is sufficient as well. Maybe add a link to our docs, since our user interface is definitely not as self explanatory as the one of vscode.

[u7229988-Rabie]

@u7229988-Rabie Yes, go ahead. Do that what tobias suggested at #96 (comment)

I would argue that for us the simple "Open / create library" plus a list of recent libraries is sufficient as well. Maybe add a link to our docs, since our user interface is definitely not as self-explanatory as the one of vscode.

Thank you for assigning me this issue.

[u7229988-Rabie]

Hello, can anyone suggest the design of the welcome page? For Instance, what kind of information do the maintainers want me to add on the welcome screen (anything particular)? I.e, buttons linking to other pages, information regarding Jabref etc.

Thank you.

[tobiasdiez]

Something like this:

[u7229988-Rabie]

I am running the latest version of Gradle (8.4). However, I am still getting "Gradle Deprecated problems". The error suggests that I should be using Gradle 9.0. Can anyone please suggest how I can solve this error? I think Gradle 8.4 is the latest Gradle version.

Thank you

[calixtus]

Please use the latest version of java to run jabref as described in the documentation (https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html)

[calixtus]

Note that the most recent version of java is 21.0.1

[Siedlerchr]

@calixtus jdk 21 is not yet working with gradle . You need 20

[ThiloteE]

As a general advice for newcomers: check out https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md for a start. Also, https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace is worth having a look at. Feel free to ask if you have any questions here on GitHub or also at JabRef's Gitter chat.

Try to open a (draft) pull request early on, so that people can see you are working on the issue and so that they can see the direction the pull request is heading towards. This way, you will likely receive valuable feedback.

[HaynesCrossley-ANU]

Hello,

I have read through this issue and was wondering if it is still available to take on. I downloaded JabRef but did not see a welcome screen when I opened the app. I have read the CONTRIBUTING.md file and would love to tackle this feature. I am asking to be assigned due to a university group project.

Hi All,

I am working with @surymishra on this issue as part of our university group assignment. We were able to add a welcome screen that loads when no database is open/selected. It dismisses when a tab is open, and if no tabs are open it appears again.

Can I please confirm that this the expected/wanted behaviour? If yes, we will next work on making the welcome screen more useful, like in the suggestions from above comments rather than just text as it is currently.

[koppor]

Looks good initally. Seems to fulfill the wish that it is shown if no database is opened.

You can submit a pull request so that more persons can comment.

[oops-shlok]

Hi @koppor! I came across this issue and would love to work on it. I am eager to contribute to JabRef and have completed local setup on my system. Could you please assign me this issue?

[koppor]

/assign @oops-shlok

[github-actions]

👋 Hey @oops-shlok, thank you for your interest in this issue! 🎉

We're excited to have you on board. Start by exploring our Contributing guidelines, and don't forget to check out our workspace setup guidelines to get started smoothly.

In case you encounter failing tests during development, please check our developer FAQs!

Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on JabRef's Gitter chat. And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.

Happy coding! 🚀

⏳ Please note, you will be automatically unassigned if the issue isn't closed within 90 days (by 02 May 2025). A maintainer can also add the "📌 Pinned"" label to prevent automatic unassignment.

[oops-shlok]

hi @koppor! So, I have developed the welcome page like this so far. The functionality for new library and open library is done. Next, I will be working on Recent libraries. Please let me know if this design looks good or any changes are needed.

Screen.Recording.2025-02-02.at.9.54.51.PM.mov

[koppor]

I think, the comments of a previous PR are all adressed (#12017 (comment)), thus, this is good to go! Please submit a PR.

We need to create a new issue for "page on first start". We internally currently work on describing that https://github.com/JabRef/jabref-issue-melting-pot/issues/49.

[oops-shlok]

Sure! I have completed the recent libraries part too. Just need to fix a bug. Once its done, I’ll submit the PR. Thanks!

[oops-shlok]

Hi @koppor! I have submitted the PR. Please review it once.