Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve welcome page #12664

Open
7 tasks
koppor opened this issue Mar 9, 2025 · 2 comments
Open
7 tasks

Improve welcome page #12664

koppor opened this issue Mar 9, 2025 · 2 comments

Comments

@koppor
Copy link
Member

koppor commented Mar 9, 2025

This is a follow-up to #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

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: #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).

Initial "look and feel"

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

More links

Add more links as described at #12461 (comment)


Related Work for this Issue

@aniket866
Copy link

aniket866 commented Mar 11, 2025

@koppor
Please assign , Interested to work

@koppor
Copy link
Member Author

koppor commented Mar 11, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants