Add 'Open example library' button to Welcome Tab #13068

khushp3 · 2025-05-06T08:30:14Z

Moved Chocolate.bib to jabgui/src/main/resources
Added an "Open example library" button
Loads Chocolate.bib from resources
Saves it as a temp file
Opens it as a new library
Deletes it when the VM terminates

Mandatory checks

I own the copyright of the code submitted and I license 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 (if change is visible to the user)
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.

- Moved Chocolate.bib to jabgui/src/main/resources - Added an "Open example library" button - Loads Chocolate.bib from resources - Saves it as a temp file - Opens it as a new library - Deletes it when the VM terminates

trag-bot · 2025-05-06T08:32:21Z

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

+                                taskExecutor).openFiles(List.of(tmpFile));
+                        tmpFile.toFile().deleteOnExit();
+                    } catch (IOException ex) {
+                        throw new RuntimeException(ex);


Using exceptions for control flow is not recommended. Exceptions should be used for exceptional states, not for normal control flow.

Just add a logger statement here or show an errror dialog
dialogService.showEror...

Siedlerchr · 2025-05-07T18:43:49Z

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

+                    }
+                }
+            } catch (IOException ex) {
+                throw new RuntimeException(ex);


koppor

tmp file is not the right approach.

koppor · 2025-05-08T12:52:31Z

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

+                if (in != null) {
+                    Path tmpFile = Files.createTempFile("example-library", ".bib");
+                    try {
+                        Files.copy(in, tmpFile, StandardCopyOption.REPLACE_EXISTING);


Wrong approach.

Create a new library

Fill it with contents of Chocolate.bib. For that, you need to use org.jabref.logic.importer.fileformat.BibtexParser#BibtexParser(org.jabref.logic.importer.ImportFormatPreferences). Then you can call org.jabref.model.database.BibDatabase#insertEntries(java.util.List<org.jabref.model.entry.BibEntry>) - similar to addExampleButton.setOnAction(...

koppor · 2025-05-09T19:46:13Z

jabgui/src/main/resources/Chocolate.bib

Please try to keep the file in jablib. Report back if you cannot load it.

- Passes each entry in "Chocolate.bib" - Creates an empty database object - Inserts the entries into the database - Wraps the database in BibDatabaseContext - Creates a new library tab with the data loaded from "Chocolate.bib"

koppor · 2025-05-12T17:31:03Z

@khushp3 please do not request a review before you have addressed the issues risen by the tests

koppor · 2025-05-13T15:35:56Z

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

+                BibtexParser bibtexParser = new BibtexParser(preferences.getImportFormatPreferences(), fileUpdateMonitor);
+                List<BibEntry> entries = bibtexParser.parseEntries(in);
+
+                BibDatabase database = new BibDatabase();
+                database.insertEntries(entries);
+
+                BibDatabaseContext databaseContext = new BibDatabaseContext(database);


Seeing this, there is a more simpler way:

Suggested change

BibtexParser bibtexParser = new BibtexParser(preferences.getImportFormatPreferences(), fileUpdateMonitor);

List<BibEntry> entries = bibtexParser.parseEntries(in);

BibDatabase database = new BibDatabase();

database.insertEntries(entries);

BibDatabaseContext databaseContext = new BibDatabaseContext(database);

reader = Importer.getReader(inputStream);

BibtexParser bibtexParser = new BibtexParser(preferences.getImportFormatPreferences(), fileUpdateMonitor);

ParserResult result = bibtexParser.parse(reader);

BibDatabaseContext databaseContext = result.getDatabaseContext();

I found simlar code in org.jabref.logic.importer.fileformat.BibtexParser

koppor · 2025-05-13T15:36:18Z

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

-        fileHistoryMenu.getItems().addListener((ListChangeListener<MenuItem>) _ -> updateWelcomeRecentLibraries());
+        fileHistoryMenu.getItems().addListener((ListChangeListener<MenuItem>) e -> updateWelcomeRecentLibraries());


Is this change AI generated? Please keep _

…r-issue-13014

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

koppor · 2025-05-15T13:02:50Z

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

 import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.model.util.FileUpdateMonitor;

+import static org.jabref.gui.edit.automaticfiededitor.AbstractAutomaticFieldEditorTabViewModel.LOGGER;


Copy and paste issue - see https://devdocs.jabref.org/code-howtos/logging.html how to initialize the logger

koppor · 2025-05-15T13:03:56Z

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

+                Reader reader;
+                reader = Importer.getReader(in);


Merge in one line; you can even move it up into the try braces

koppor · 2025-05-15T13:06:05Z

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

@@ -124,7 +134,28 @@ private VBox createWelcomeStartBox() {
                stateManager, fileUpdateMonitor, entryTypesManager, undoManager, clipBoardManager,
                taskExecutor).execute());

-        return createVBoxContainer(startLabel, newLibraryLink, openLibraryLink);
+        Hyperlink openExampleLibraryLink = new Hyperlink(Localization.lang("Open example library"));


The string should be New example library

Rename "New library" to "New empty library"

position it one above, so that the order is

New empty library

New example library

Open library

- Changed string names

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

…d JabRef_en.properties - Correctly imported LOGGER

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java

trag-bot · 2025-05-15T14:25:30Z

jabgui/src/main/java/org/jabref/gui/actions/StandardActions.java

@@ -62,7 +62,7 @@ public enum StandardActions implements Action {
    SKIMMED(Localization.lang("Set read status to skimmed"), IconTheme.JabRefIcons.READ_STATUS_SKIMMED, KeyBinding.SKIMMED),
    RELEVANCE(Localization.lang("Relevance"), IconTheme.JabRefIcons.RELEVANCE),
    RELEVANT(Localization.lang("Toggle relevance"), IconTheme.JabRefIcons.RELEVANCE),
-    NEW_LIBRARY(Localization.lang("New library"), IconTheme.JabRefIcons.NEW),
+    NEW_LIBRARY(Localization.lang("New empty library"), IconTheme.JabRefIcons.NEW),


The change from 'New library' to 'New empty library' should be consistent with other strings and grouped semantically. Ensure that similar actions use consistent terminology.

jablib/src/main/resources/l10n/JabRef_en.properties

koppor · 2025-05-15T15:03:22Z

I fixed the small test issues (wrong variable order and translation strings)

Now, it is good to go.

Thank you for the efforts!

trag-bot · 2025-05-15T15:03:38Z

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

trag-bot · 2025-05-15T15:05:54Z

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

Changes:

3f80667

- Moved Chocolate.bib to jabgui/src/main/resources - Added an "Open example library" button - Loads Chocolate.bib from resources - Saves it as a temp file - Opens it as a new library - Deletes it when the VM terminates

trag-bot bot reviewed May 6, 2025

View reviewed changes

khushp3 changed the title ~~Changes:~~ Changes: #13014 May 6, 2025

khushp3 changed the title ~~Changes: #13014~~ Changes: May 6, 2025

khushp3 changed the title ~~Changes:~~ Added 'Open example library' button to Welcome Tab May 6, 2025

Siedlerchr reviewed May 7, 2025

View reviewed changes

koppor changed the title ~~Added 'Open example library' button to Welcome Tab~~ Add 'Open example library' button to Welcome Tab May 8, 2025

koppor requested changes May 8, 2025

View reviewed changes

koppor reviewed May 9, 2025

View reviewed changes

jabgui/src/main/resources/Chocolate.bib Outdated

Copy link

Member

koppor May 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please try to keep the file in jablib. Report back if you cannot load it.

khushp3 added 3 commits May 11, 2025 12:29

Merge branch 'main' into fix-for-issue-13014

6046fa6

- Loads the file "Chocolate.bib" from jablib

ce885ca

- Passes each entry in "Chocolate.bib" - Creates an empty database object - Inserts the entries into the database - Wraps the database in BibDatabaseContext - Creates a new library tab with the data loaded from "Chocolate.bib"

Merge branch 'main' into fix-for-issue-13014

1e69937

khushp3 requested a review from koppor May 12, 2025 14:42

khushp3 and others added 3 commits May 13, 2025 19:49

- Removed unnecessary imports

c166d16

- Moved Chocolate.bib to the right folder

07752f7

Merge branch 'main' into fix-for-issue-13014

302e6c8

koppor requested changes May 13, 2025

View reviewed changes

khushp3 added 3 commits May 15, 2025 21:00

- Fixing issues

3cf5587

Merge remote-tracking branch 'origin/fix-for-issue-13014' into fix-fo…

53119d4

…r-issue-13014

- Updating implementation with recommended changes

53e2ee7

trag-bot bot reviewed May 15, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java Show resolved Hide resolved

koppor mentioned this pull request May 15, 2025

Remove unused variable #13117

Merged

1 task

koppor requested changes May 15, 2025

View reviewed changes

- Changed order of links on welcome tab

8d02f78

- Changed string names

trag-bot bot reviewed May 15, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java Show resolved Hide resolved

- Changed dependent "New empty library strings" in StandardActions an…

36ff6e6

…d JabRef_en.properties - Correctly imported LOGGER

trag-bot bot reviewed May 15, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java Show resolved Hide resolved

trag-bot bot reviewed May 15, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/WelcomeTab.java Show resolved Hide resolved

trag-bot bot reviewed May 15, 2025

View reviewed changes

koppor reviewed May 15, 2025

View reviewed changes

jablib/src/main/resources/l10n/JabRef_en.properties Outdated Show resolved Hide resolved

koppor added 2 commits May 15, 2025 17:00

Update jablib/src/main/resources/l10n/JabRef_en.properties

8985498

Merge branch 'main' into fix-for-issue-13014

a345370

koppor marked this pull request as ready for review May 15, 2025 15:01

koppor enabled auto-merge May 15, 2025 15:01

Fix variable ordering

7d59469

koppor approved these changes May 15, 2025

View reviewed changes

koppor added this pull request to the merge queue May 15, 2025

Merged via the queue into JabRef:main with commit dca5cd5 May 15, 2025
1 check passed

github-actions bot mentioned this pull request May 15, 2025

Welcome Tab: "Open example library" #13014

Closed

		fileHistoryMenu.getItems().addListener((ListChangeListener<MenuItem>) _ -> updateWelcomeRecentLibraries());
		fileHistoryMenu.getItems().addListener((ListChangeListener<MenuItem>) e -> updateWelcomeRecentLibraries());

Uh oh!

Add 'Open example library' button to Welcome Tab #13068

Add 'Open example library' button to Welcome Tab #13068

Uh oh!

Conversation

khushp3 commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Mandatory checks

Uh oh!

trag-bot bot May 6, 2025

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 left a comment

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 May 12, 2025

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trag-bot bot May 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

koppor commented May 15, 2025

Uh oh!

trag-bot bot commented May 15, 2025

Uh oh!

trag-bot bot commented May 15, 2025

Uh oh!

Uh oh!

Uh oh!

khushp3 commented May 6, 2025 •

edited

Loading