Added "Add example entry" and "Import existing PDFs" when a library is empty by sanjyot242 · Pull Request #12741 · JabRef/jabref

sanjyot242 · 2025-03-14T02:34:08Z

Added "Add example entry" and "Import existing PDFs" when a library is empty
Add listeners to track database and table entry changes to show buttons only when database is empty

Closes #12662

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.

-Ensures button is hidden when entries exist but are filtered -Add listeners to track database and table entry changes

…e-12662

-used localization -added styles for button

…e-12662 # Conflicts: # src/main/java/org/jabref/gui/maintable/MainTable.java

-checks if directory exists -triggers search for unlinked files ( if directory exists ) -Shows notification and open library properties ( if directory doesn't exist)

sanjyot242 · 2025-03-18T06:19:53Z

+            dialogService.showWarningDialogAndWait(
+                    Localization.lang("File directory is not set or does not exist!"),


Used Key which was already defined in properties , Should i update ?

…e-12662 # Conflicts: # src/main/java/org/jabref/gui/Base.css

koppor · 2025-03-20T12:59:54Z

+            dialogService.showWarningDialogAndWait(
+                    Localization.lang("File directory is not set or does not exist!"),


Yes, but please think whether it could be critical error, then leave the !.

koppor · 2025-03-20T13:02:56Z

I need to try out the directory.

Global prefs:

If unsaved AND "search and store relative", then not possible to import PDFs.
If unsaved AND "Main file directory" exists, one can import PDFs.
If saved, import should be good to go

…e-12662

- Removed Unnecessary comments - Used withField for BibEntry instead of setField

-updating with period

sanjyot242 · 2025-03-21T18:10:38Z

I need to try out the directory.

Global prefs:

If unsaved AND "search and store relative", then not possible to import PDFs.

If unsaved AND "Main file directory" exists, one can import PDFs.

If saved, import should be good to go

Hey ,
So i didnt understand the flow clearly yet , According to what was mentioned in the issue , the checks were with respect to fileDirectory .

Could you please explain in detail about the global prefs checks .

Thanks

koppor · 2025-03-22T07:46:12Z

I need to try out the directory.

Global prefs:

If unsaved AND "search and store relative", then not possible to import PDFs.

If unsaved AND "Main file directory" exists, one can import PDFs.

If saved, import should be good to go

Hey ,
So i didnt understand the flow clearly yet , According to what was mentioned in the issue , the checks were with respect to fileDirectory .

Could you please explain in detail about the global prefs checks .

Thanks

Please. Think of a user perspective. Read on at https://docs.jabref.org/finding-sorting-and-cleaning-entries/filelinks#directories-for-files, then my specification makes sense?!

koppor · 2025-03-22T07:47:16Z

With

Check if org.jabref.model.database.BibDatabaseContext#getFileDirectories is non-empty

That wish should be fulfilled... Hopefully. Please check

sanjyot242 · 2025-03-23T20:32:50Z

With

Check if org.jabref.model.database.BibDatabaseContext#getFileDirectories is non-empty

That wish should be fulfilled... Hopefully. Please check

Yes, I’m checking this condition:

List<Path> fileDirectories = database.getFileDirectories(filePreferences);

if (fileDirectories.isEmpty()) {
    // show warning and open library properties
} else {
    // find unlinked files
}

Just to confirm inside the else block, I should also check the global preferences, right?

koppor · 2025-03-23T20:45:26Z

+            libraryTab.showAndEdit(entry);
+        });
+
+        Button importPdfsButton = new Button(Localization.lang("Import existing PDFs"));


// TODO: activate only if directories available // enable if !databaseContext.getFileDirectories(filePreferences).isEmpty()

Add hover if disabled: "Please configure a file directory"

with respect to initial issue - Show a notification that no directory exist and then open the library properties.

what about open library properties ? are we doing that ?

When writing the issue, I forgot about the "store files next to bib file"

OK, maybe, I had the more right idea back then.

Then "just" modifiy to use "diaglosService.notify" and not some dialog -- reason: less clicks.

Can you also try to focus the field for the directory please?

koppor · 2025-03-23T20:47:15Z

+            dialogService.showWarningDialogAndWait(
+                    Localization.lang("File directory is not set or does not exist."),
+                    Localization.lang("Please configure a file directory"));
+
+            LibraryPropertiesAction libraryPropertiesAction = new LibraryPropertiesAction(stateManager);
+            libraryPropertiesAction.execute();


Should never happen

…e-12662

-Added focus for library-specific file directory

-Removed Unused Localization keys -Updated to lambda for better readability

…e-12662

koppor · 2025-03-28T05:15:48Z

+
+        updatePlaceholder(placeholderBox);
+
+        database.getDatabase().getEntries().addListener((ListChangeListener<BibEntry>) change -> updatePlaceholder(placeholderBox));


Does following work, too? - I don't see any usage of the variable.

Suggested change

database.getDatabase().getEntries().addListener((ListChangeListener<BibEntry>) change -> updatePlaceholder(placeholderBox));

database.getDatabase().getEntries().addListener(_ -> updatePlaceholder(placeholderBox));

I'm sticking with the original code since the lambda with an underscore parameter creates ambiguity error.

koppor · 2025-03-28T05:15:59Z

+
+        database.getDatabase().getEntries().addListener((ListChangeListener<BibEntry>) change -> updatePlaceholder(placeholderBox));
+
+        this.getItems().addListener((ListChangeListener<BibEntryTableViewModel>) change -> updatePlaceholder(placeholderBox));


Suggested change

this.getItems().addListener((ListChangeListener<BibEntryTableViewModel>) change -> updatePlaceholder(placeholderBox));

this.getItems().addListener(_ -> updatePlaceholder(placeholderBox));

I'm sticking with the original code since the lambda with an underscore parameter creates ambiguity error.

koppor · 2025-03-28T05:16:55Z

+        BibEntry exampleEntry = new BibEntry(StandardEntryType.Article);
+        exampleEntry.withField(StandardField.AUTHOR, "Oliver Kopp and Carl Christian Snethlage and Christoph Schwentker");
+        exampleEntry.withField(StandardField.TITLE, "JabRef: BibTeX-based literature management software");
+        exampleEntry.withField(StandardField.JOURNAL, "TUGboat");
+        exampleEntry.withField(StandardField.VOLUME, "44");
+        exampleEntry.withField(StandardField.NUMBER, "3");
+        exampleEntry.withField(StandardField.PAGES, "441--447");
+        exampleEntry.withField(StandardField.DOI, "10.47397/tb/44-3/tb138kopp-jabref");
+        exampleEntry.withField(StandardField.ISSN, "0896-3207");
+        exampleEntry.withField(StandardField.ISSUE, "138");
+        exampleEntry.withField(StandardField.YEAR, "2023");


Chain these statemetns

Suggested change

BibEntry exampleEntry = new BibEntry(StandardEntryType.Article);

exampleEntry.withField(StandardField.AUTHOR, "Oliver Kopp and Carl Christian Snethlage and Christoph Schwentker");

exampleEntry.withField(StandardField.TITLE, "JabRef: BibTeX-based literature management software");

exampleEntry.withField(StandardField.JOURNAL, "TUGboat");

exampleEntry.withField(StandardField.VOLUME, "44");

exampleEntry.withField(StandardField.NUMBER, "3");

exampleEntry.withField(StandardField.PAGES, "441--447");

exampleEntry.withField(StandardField.DOI, "10.47397/tb/44-3/tb138kopp-jabref");

exampleEntry.withField(StandardField.ISSN, "0896-3207");

exampleEntry.withField(StandardField.ISSUE, "138");

exampleEntry.withField(StandardField.YEAR, "2023");

BibEntry exampleEntry = new BibEntry(StandardEntryType.Article)

.withField(StandardField.AUTHOR, "Oliver Kopp and Carl Christian Snethlage and Christoph Schwentker")

.withField(StandardField.TITLE, "JabRef: BibTeX-based literature management software")

.withField(StandardField.JOURNAL, "TUGboat")

.withField(StandardField.VOLUME, "44")

.withField(StandardField.NUMBER, "3")

.withField(StandardField.PAGES, "441--447")

.withField(StandardField.DOI, "10.47397/tb/44-3/tb138kopp-jabref")

.withField(StandardField.ISSN, "0896-3207")

.withField(StandardField.ISSUE, "138")

.withField(StandardField.YEAR, "2023");

koppor · 2025-03-28T05:17:32Z

+            FindUnlinkedFilesAction findUnlinkedFilesAction = new FindUnlinkedFilesAction(dialogService, stateManager);
+            findUnlinkedFilesAction.execute();


Indent is off

koppor · 2025-03-28T05:17:43Z

+
+

Remove empty lines at end

koppor · 2025-03-28T05:29:54Z

Tried out. Works.

Is it possible to increase the size of the "heading"?

Maybe to the headings of the Welcome Tab?

…e-12662

-Label Style Changes

…into fix-issue-12662

trag-bot · 2025-03-31T18:20:25Z

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

solved

…s empty (JabRef#12741) * Add placeholder with "Add Example Entry" for empty library -Ensures button is hidden when entries exist but are filtered -Add listeners to track database and table entry changes * Updated code based on draft review ( Import pdf pending) -used localization -added styles for button * Added function for Import existing PDFs -checks if directory exists -triggers search for unlinked files ( if directory exists ) -Shows notification and open library properties ( if directory doesn't exist) * updated CHANGELOG.md * Fixed localization issues and checkstyle * Fixed localization issues * submodules changes * roll back .gitmodules * Added comment at the right place * Resolved Review Comments - Removed Unnecessary comments - Used withField for BibEntry instead of setField * Removed Exclamation mark , should be avoided in UI messages. -updating with period * -Refactored function name to importPdfs -Added focus for library-specific file directory * -Refactored importPDFs to follow fail fast principles -Removed Unused Localization keys -Updated to lambda for better readability * -rewriteRun changes * -Resolved Review Changes . -Label Style Changes --------- Co-authored-by: Christoph <siedlerkiller@gmail.com>

Add placeholder with "Add Example Entry" for empty library

0ad6aa5

-Ensures button is hidden when entries exist but are filtered -Add listeners to track database and table entry changes

trag-bot Bot reviewed Mar 14, 2025

View reviewed changes

Comment thread src/main/java/org/jabref/gui/maintable/MainTable.java Outdated

koppor mentioned this pull request Mar 14, 2025

Refine CONTRIBUTING.md #12742

Merged

7 tasks

koppor reviewed Mar 14, 2025

View reviewed changes

Comment thread src/main/java/org/jabref/gui/maintable/MainTable.java Outdated

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

91a755c

…e-12662

koppor mentioned this pull request Mar 16, 2025

Refine PULL_REQUEST_TEMPLATE.md #12749

Merged

6 tasks

sanjyot242 added 6 commits March 17, 2025 20:31

Updated code based on draft review ( Import pdf pending)

1316e10

-used localization -added styles for button

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

fd92723

…e-12662 # Conflicts: # src/main/java/org/jabref/gui/maintable/MainTable.java

Added function for Import existing PDFs

0ebccda

-checks if directory exists -triggers search for unlinked files ( if directory exists ) -Shows notification and open library properties ( if directory doesn't exist)

updated CHANGELOG.md

c3e6ba5

Fixed localization issues and checkstyle

a58fe3d

Fixed localization issues

82a6ff4

sanjyot242 commented Mar 18, 2025

View reviewed changes

sanjyot242 changed the title ~~Add placeholder with "Add Example Entry" for empty library~~ Added "Add example entry" and "Import existing PDFs" when a library is empty Mar 18, 2025

submodules changes

bee4510

sanjyot242 marked this pull request as ready for review March 18, 2025 06:54

trag-bot Bot reviewed Mar 18, 2025

View reviewed changes

Comment thread src/main/java/org/jabref/gui/maintable/MainTable.java Outdated

sanjyot242 added 3 commits March 19, 2025 18:18

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

8c72d94

…e-12662 # Conflicts: # src/main/java/org/jabref/gui/Base.css

roll back .gitmodules

3b4cacb

Added comment at the right place

612e994

sanjyot242 requested a review from koppor March 20, 2025 12:13

koppor requested changes Mar 20, 2025

View reviewed changes

sanjyot242 added 3 commits March 21, 2025 10:34

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

f3f8a42

…e-12662

Resolved Review Comments

56e00a2

- Removed Unnecessary comments - Used withField for BibEntry instead of setField

Removed Exclamation mark , should be avoided in UI messages.

6f64742

-updating with period

sanjyot242 requested a review from koppor March 22, 2025 02:20

sanjyot242 closed this Mar 23, 2025

sanjyot242 reopened this Mar 23, 2025

koppor requested changes Mar 23, 2025

View reviewed changes

sanjyot242 added 3 commits March 26, 2025 21:47

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

30bc533

…e-12662

-Refactored function name to importPdfs

6c74e41

-Added focus for library-specific file directory

-Refactored importPDFs to follow fail fast principles

d5610ce

-Removed Unused Localization keys -Updated to lambda for better readability

trag-bot Bot reviewed Mar 27, 2025

View reviewed changes

Comment thread src/main/java/org/jabref/gui/maintable/MainTable.java

sanjyot242 added 3 commits March 26, 2025 23:56

-rewriteRun changes

df3e33f

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

1f84a09

…e-12662

Merge branch 'main' into fix-issue-12662

a5463a4

sanjyot242 requested a review from koppor March 27, 2025 07:24

koppor previously requested changes Mar 28, 2025

View reviewed changes

koppor added the component: maintable label Mar 28, 2025

koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Mar 28, 2025

sanjyot242 added 3 commits March 28, 2025 16:53

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

9537ad1

…e-12662

-Resolved Review Changes .

c17222d

-Label Style Changes

Merge branch 'fix-issue-12662' of https://github.com/sanjyot242/jabref …

d85737e

…into fix-issue-12662

sanjyot242 requested a review from koppor March 29, 2025 00:10

Merge branch 'main' into fix-issue-12662

bf41a64

Siedlerchr approved these changes Mar 31, 2025

View reviewed changes

Siedlerchr enabled auto-merge March 31, 2025 18:22

Siedlerchr added this pull request to the merge queue Mar 31, 2025

Merged via the queue into JabRef:main with commit 5c03936 Mar 31, 2025

		dialogService.showWarningDialogAndWait(
		Localization.lang("File directory is not set or does not exist!"),


		updatePlaceholder(placeholderBox);

		database.getDatabase().getEntries().addListener((ListChangeListener<BibEntry>) change -> updatePlaceholder(placeholderBox));


		database.getDatabase().getEntries().addListener((ListChangeListener<BibEntry>) change -> updatePlaceholder(placeholderBox));

		this.getItems().addListener((ListChangeListener<BibEntryTableViewModel>) change -> updatePlaceholder(placeholderBox));

	this.getItems().addListener((ListChangeListener<BibEntryTableViewModel>) change -> updatePlaceholder(placeholderBox));
	this.getItems().addListener(_ -> updatePlaceholder(placeholderBox));

		FindUnlinkedFilesAction findUnlinkedFilesAction = new FindUnlinkedFilesAction(dialogService, stateManager);
		findUnlinkedFilesAction.execute();

Uh oh!

Conversation

sanjyot242 commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Mandatory checks

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

koppor commented Mar 20, 2025

Uh oh!

sanjyot242 commented Mar 21, 2025

Uh oh!

koppor commented Mar 22, 2025

Uh oh!

koppor commented Mar 22, 2025

Uh oh!

sanjyot242 commented Mar 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanjyot242 Mar 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koppor commented Mar 28, 2025

Uh oh!

trag-bot Bot commented Mar 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sanjyot242 commented Mar 14, 2025 •

edited

Loading

sanjyot242 commented Mar 23, 2025 •

edited

Loading

sanjyot242 Mar 23, 2025 •

edited

Loading