jabref icon indicating copy to clipboard operation
jabref copied to clipboard

Improve welcome page

Open koppor opened this issue 9 months ago • 9 comments

This is a follow-up to https://github.com/JabRef/jabref/pull/12461. This is a refinement of the GSoC project description https://github.com/JabRef/jabref/wiki/GSOC-2025-ideas-list#welcome-walkthrough covering the welcome tab only.


[!Note] A welcome walkthrough is a different story Please read on at https://www.appcues.com/blog/the-5-best-walkthrough-examples. Then think of which of the features described at https://docs.jabref.org/ could be rendered as walkthrough.

There should be guides (simlar to Visusal Studio Code). When working on this, one really needs to come up with concrete proposals.


Currently, JabRef expects new users to "play around" with the UI or read the user documentation (https://docs.jabref.org/). A refined "Welcome Page" should offer guidance.

Current ideas area:

Working with files

  • keep the current page (introduced at https://github.com/JabRef/jabref/pull/12461)

First-start settings

JabRef offers many things to setup. There should be a quick possibility to set the default things. Currently, the "important" things to change are grouped in the preferences by functionality and not by importance for a first-time-user. With this part of the welcome page, this should be offered.

Example libraries

Welcome page should offer to open the example library Chocolate.bib. Available at https://github.com/JabRef/jabref/blob/main/src/test/resources/testbib/Chocolate.bib. The library should be distributed with JabRef.

More example libraries could be added. Please think of something one could need. Also improve user documentation then. Initial example to show some features of JabRef is https://github.com/JabRef/jabref/blob/main/src/test/resources/testbib/complex.bib. -- However, if possible, Chocolate.bib should be extended to show (nearly) all features of JabRef. Example blog post where Chocolate.bib was used to show a feature: https://blog.jabref.org/2025/03/08/Consistency-Check/

More work requires the task to come of with "nice" default groups for following user groups:

  • clean users: Not wanting to have any hints, because they know what they are doing.
  • first-time users: managing a library the first time (e.g., master thesis)
  • pro users: Wanting to have all features shown

First-time settings

Offer buttons

  • Configure for small libraries
  • Configure for large libraries (disabled some time-consuming features)

Background: https://github.com/JabRef/jabref/issues/9491

Configure a paper directory

We aim for configuration defaults which don't require any manual adjustment in 90% of the cases. The only thing which has to be configured is the "Main file directory" at "External programs".

I think, JabRef should ask for that directory at the first start. Possibly just by a dialog:

Your main file directory is not configured yet. 
[configure now] [skip configuration]

In other words: Implement a feature allowing users to easily set up and manage their paper directory.

Configure other things

"External programs" for push-to-application feature: Program should be auto detected.

Maybe more.

Enable online services

JabRef should list all online services, allow a user enabling them and add a link to the user documentation (typically a question mark button).

  • [ ] Online services
    • [ ] Update checks
    • [ ] Online Service Grobid (refs https://github.com/koppor/jabref/issues/566)
    • [ ] Fetchers
    • [ ] Full text search
  • [ ] Add link Privacy Policy https://github.com/JabRef/jabref/blob/main/PRIVACY.md

Initial "look and feel"

  • [ ] Enable/disable showing "Citation key" column (refs https://github.com/JabRef/jabref/issues/10510) - default: enabled

Note: This could be obsolete with sensible default for the role of JabRef users (see above).

More links

Add more links as described at https://github.com/JabRef/jabref/pull/12461#issuecomment-2708900164


Related Work for this Issue

  • Firefox: https://www.mozilla.org/de/firefox/
  • Welcome page of VS Code: https://github.com/JabRef/jabref/issues/12272#issuecomment-2523112156
  • VSCode : For new users, VScode has a nice walkthrough
  • The issue is based on https://github.com/JabRef/jabref/issues/12272

koppor avatar Mar 09 '25 17:03 koppor

@koppor Please assign , Interested to work

aniket866 avatar Mar 11 '25 20:03 aniket866

@aniket866 May I ask whether you are familiar with "CONTRIBUTING.md"? https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md Should I assist you in reading it?

koppor avatar Mar 11 '25 21:03 koppor

/assign-me

hea7hen avatar Apr 07 '25 18:04 hea7hen

👋 Hey @hea7hen, 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! 🚀

github-actions[bot] avatar Apr 07 '25 18:04 github-actions[bot]

Its about a "welcome tour" - Zotero 7 after a start:

Image

New features just redirect to: https://www.zotero.org/blog/zotero-7/

koppor avatar Apr 13 '25 18:04 koppor

📋 Assignment Update

Hi @hea7hen, due to inactivity, you have been unassigned from this issue.

Next steps


If you still want to work on this:

  • Submit a pull request showing your current state. You will be automatically assigned again.
  • Ask a maintainer to assign you again.

github-actions[bot] avatar May 05 '25 12:05 github-actions[bot]

@Yubo-Cao please comment on this issue so that we can assign you

subhramit avatar Jun 05 '25 19:06 subhramit

/assign-me

Yubo-Cao avatar Jun 05 '25 20:06 Yubo-Cao

👋 Hey @Yubo-Cao, 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.

For questions on JabRef functionality and the code base, you can consult the JabRef Guru or ask on our Gitter chat.

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! 🚀

github-actions[bot] avatar Jun 05 '25 20:06 github-actions[bot]

We think that this issue was fixed. Please head to https://builds.jabref.org/main to download a development build and try it out.

For any feedback, add a comment to the pull request at https://github.com/JabRef/jabref/pull/13407.

github-actions[bot] avatar Aug 03 '25 14:08 github-actions[bot]

We think that this issue was fixed. Please head to https://builds.jabref.org/main to download a development build and try it out.

For any feedback, add a comment to the pull request at https://github.com/JabRef/jabref/pull/13595.

github-actions[bot] avatar Aug 06 '25 17:08 github-actions[bot]

We think that this issue was fixed. Please head to https://builds.jabref.org/main to download a development build and try it out.

For any feedback, add a comment to the pull request at https://github.com/JabRef/jabref/pull/13679.

github-actions[bot] avatar Aug 22 '25 18:08 github-actions[bot]