Add checks and warnings in SLR for non-empty directories #11088

subhramit · 2024-03-24T11:51:45Z

Description

When starting a new Systematic Literature Review (SLR), earlier, the users were allowed to create a new SLR (the Start survey button wasn't blocked) even if a non-empty directory was selected. There were no notes or warnings as well:

This would also sometimes cause the following exception to be thrown:

Through the changes made,

A help text has been added as a note stating that the selected directory must be empty:
A warning (in red) is shown and the Start survey button is blocked if a non-empty directory is selected:

The Start survey button is now only enabled when the selected directory is empty (thus avoiding errors as well):

Edit: For purposes of uniformity, we decided to stick to the global warning-message in Base.css instead of the red warning label depicted above:

Mandatory checks

Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
~~- [ ] 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.

…hanges

koppor

Minor changes, otherwise: LGTM

Thank you for diving into the SLR topic. This is a very highly-ranked topic by me.

CHANGELOG.md

src/main/java/org/jabref/gui/slr/ManageStudyDefinition.css

src/main/java/org/jabref/gui/slr/ManageStudyDefinitionView.java

ThiloteE · 2024-03-25T10:59:26Z

To ease organizational workflows I have linked the pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message. The pull request must be on the default branch.

close

closes

closed

fix

fixes

fixed

resolve

resolves

resolved

If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request also closes the referenced pull request.

The syntax for closing keywords depends on whether the issue is in the same repository as the pull request.

Example:

✅ Fix #xyz links pull-request to issue. Merging the PR will close the Issue.
✅ Fix https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the Issue.
✅ Fix https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the Issue.
❌ Fix [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the Issue.

koppor

See CSS comment

…hanges

koppor · 2024-03-25T13:15:25Z

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

@@ -1308,6 +1308,10 @@ We want to have a look that matches our icons in the tool-bar */
    -fx-text-fill: -jr-warn;
 }

+.warning-label {


Why couldn't you use the class .warning-message (instead of introducing a new class) with the color -jr-warn? (See line 76)

JabRef tries to have consistent UI colors.

Yes, actually I have night light on on my laptop, so couldn't see the orange warning too well. So I stuck to red.
Then when I realized night light was the reason, removed it. Sorry.

subhramit · 2024-03-25T13:26:32Z

To ease organizational workflows I have linked the pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword
in the pull request's description or in a commit message. The pull
request must be on the default branch.

close

closes

closed

fix

fixes

fixed

resolve

resolves

resolved

If you use a keyword to reference a pull request comment in another
pull request, the pull requests will be linked. Merging the referencing
pull request also closes the referenced pull request.
The syntax for closing keywords depends on whether the issue is in the same repository as the pull request.

Example:

✅ Fix #xyz links pull-request to issue. Merging the PR will close the Issue.

✅ Fix https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the Issue.

✅ Fix https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the Issue.

❌ Fix [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the Issue.

Thank you, edited!

koppor · 2024-03-25T13:27:44Z

src/main/resources/l10n/JabRef_en.properties

@@ -2639,3 +2639,8 @@ Redownload\ missing\ files=Redownload missing files
 Redownload\ missing\ files\ for\ current\ library?=Redownload missing files for current library?

 File\ directory\ needs\ to\ be\ set\ or\ does\ not\ exist.\nPlease\ save\ your\ library\ and\ check\ the\ preferences.=File directory needs to be set or does not exist.\nPlease save your library and check the preferences.
+
+Note\:\ The\ study\ directory\ should\ be\ empty.=Note: The study directory should be empty.


I think, the UI pattern of JabRef is to use colors to indicate "Note" and "Warning".

OK, we do have some strings with "Warning:" in front. Too much work to discuss this now. I'll just merge and we can do a follow-up for consistent UI later.

Added checks and warnings in SLR for non-empty directories

9738f21

subhramit changed the title ~~Added checks and warnings in SLR for non-empty directories~~ Add checks and warnings in SLR for non-empty directories Mar 24, 2024

This was referenced Mar 24, 2024

Creation of a new SLR: Directory has to be empty koppor/jabref#620

Closed

[SLR] Help text on directory koppor/jabref#600

Closed

subhramit added 4 commits March 24, 2024 17:37

Add missing strings in localization file

8709443

Resolve changelog merge conflict

6fcb747

Resolve changelog merge conflict(2)

b31c618

Merge branch 'main' of https://github.com/JabRef/jabref into slr-ui-c…

a5b9d58

…hanges

koppor requested changes Mar 24, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

src/main/java/org/jabref/gui/slr/ManageStudyDefinition.css Outdated Show resolved Hide resolved

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

subhramit requested review from koppor March 25, 2024 07:32

koppor requested changes Mar 25, 2024

View reviewed changes

subhramit added 2 commits March 25, 2024 18:29

Merge branch 'main' of https://github.com/JabRef/jabref into slr-ui-c…

b14d332

…hanges

Add review changes

5132142

subhramit force-pushed the slr-ui-changes branch from a39552d to 5132142 Compare March 25, 2024 13:12

koppor requested changes Mar 25, 2024

View reviewed changes

Use global warning style

976ed54

koppor reviewed Mar 25, 2024

View reviewed changes

koppor approved these changes Mar 25, 2024

View reviewed changes

koppor enabled auto-merge March 25, 2024 13:27

koppor added this pull request to the merge queue Mar 25, 2024

Merged via the queue into JabRef:main with commit 9818ba8 Mar 25, 2024
20 checks passed

subhramit deleted the slr-ui-changes branch March 25, 2024 23:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add checks and warnings in SLR for non-empty directories #11088

Add checks and warnings in SLR for non-empty directories #11088

subhramit commented Mar 24, 2024 •

edited

Loading

koppor left a comment

ThiloteE commented Mar 25, 2024

Linking a pull request to an issue using a keyword

koppor left a comment

koppor Mar 25, 2024

subhramit Mar 25, 2024 •

edited

Loading

subhramit commented Mar 25, 2024

Linking a pull request to an issue using a keyword

Example:

koppor Mar 25, 2024

subhramit Mar 25, 2024

Add checks and warnings in SLR for non-empty directories #11088

Add checks and warnings in SLR for non-empty directories #11088

Conversation

subhramit commented Mar 24, 2024 • edited Loading

Description

Mandatory checks

koppor left a comment

Choose a reason for hiding this comment

ThiloteE commented Mar 25, 2024

Linking a pull request to an issue using a keyword

Example:

koppor left a comment

Choose a reason for hiding this comment

koppor Mar 25, 2024

Choose a reason for hiding this comment

subhramit Mar 25, 2024 • edited Loading

Choose a reason for hiding this comment

subhramit commented Mar 25, 2024

Linking a pull request to an issue using a keyword

Example:

koppor Mar 25, 2024

Choose a reason for hiding this comment

subhramit Mar 25, 2024

Choose a reason for hiding this comment

subhramit commented Mar 24, 2024 •

edited

Loading

subhramit Mar 25, 2024 •

edited

Loading