Refactor file preferences #6779

calixtus · 2020-08-23T18:44:45Z

This PR is going to refactor some parts of the code in relationship with the FilePreferences. It's going to be rather big again, since FilePreferences and other Preferences objects are not clearly distinguishable and this will take probably some time for me to contemplate how to resort them.

Work in progress, but here for you to preview and to comment, if you have some good ideas.

Change in CHANGELOG.md described (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 documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

github-actions · 2020-08-23T18:45:32Z

The JabRef maintainers will add the following name to the AUTHORS file. In case you want to use a different one, please comment here and adjust your name in your git configuration for future commits.

hemantgs
Rolf Green

…rences # Conflicts: # src/main/java/org/jabref/preferences/JabRefPreferences.java # src/main/java/org/jabref/preferences/PreferencesService.java

github-actions · 2020-08-31T15:11:03Z

The JabRef maintainers will add the following name to the AUTHORS file. In case you want to use a different one, please comment here and adjust your name in your git configuration for future commits.

Nils Streijffert

calixtus · 2020-08-31T20:33:13Z

Siedlerchr · 2020-08-31T20:47:19Z

src/main/java/org/jabref/gui/preferences/LinkedFilesTabViewModel.java

+        switch (initialAutoLinkPreferences.getCitationKeyDependency()) {
+            case START -> autolinkFileStartsBibtexProperty.setValue(true);
+            case EXACT -> autolinkFileExactBibtexProperty.setValue(true);
+            case REGEX -> autolinkUseRegexProperty.setValue(true);


default missing?

mlep · 2020-08-31T21:23:26Z

@calixtus
I am a bit puzzled by the new import and export window: for me, its content is not about importing and exporting a library, but about the actions taking place when opening and saving a library.
If this content is called import and export, I guess it will be confused with custom import and export, and with the menus file -> import and file -> export.

Note 1: in the new import and export window, the file reformatting section use both save and export, adding to my confusion. My guess is that only save should be used.
Note 2: In Jabref 5.1, in the menu Library -> Library properties, Save is used. Except for the title, which is Export sort order. Confusing. I guess the title should beSave sort order.

calixtus · 2020-08-31T22:21:24Z

calixtus · 2020-08-31T22:26:39Z

@mlep I reworded the tab again to FileTab.
We talked here at JabCon about the difference between SaveSortOrder in LibraryProperties and ExportSortOrder in the PreferencesTab: ExportSortOrder in the Preferences takes effect probably in the custom exporters, while SaveSortOrder has only effect on saving the bib file.

mlep · 2020-09-01T06:53:00Z

@calixtus Thank for clarifying.
So, if we go with " Options -> Preferences is for default behavior, and Library -> Library properties menu is for a specific file " (as I wrote here: https://docs.jabref.org/setup), I am wondering where to define the default saving order for the library in the Preferences.

In the future, will Options -> Manage custom exports and Options -> Manage custom imports integrate the preferences window? In such a case, an Import and export page in the Preferences will need to be created (and will likely contain the Export sort order).

Happy JabCon20!

calixtus · 2020-09-01T09:07:50Z

Yes, thanks for that thought. Refactoring the preferences is a lengthy process I'm working on since some time now and especially here I was pretty clueless about how to reorder them.
It's exactly as you have described it, the options-menu should present all the general and default options for jabref, the library menu the library-specific options which override the general options.
Obviously, the default SaveSortOrder was abolished in favor of an alphabetical SortOrder, which can be adjusted for every single library via library properties, some time ago.
My plan is to integrate all the options dialogues into one grup-d and also in the more further future to integrate all the library properties dialogs into an unified library properties dialog, so we can abolish the "options" menu at all and move the options->preferences menucommand into another menu (like file).

mlep · 2020-09-01T09:14:23Z

Thank you for your explanation.
I am recognizing your huge effort in improving JabRef and do not want to be disturbing.

calixtus · 2020-09-01T10:34:55Z

Thank you for your explanation.
I am recognizing your huge effort in improving JabRef and do not want to be disturbing.

The opposite is the case, I'm thankful for critics, feedback and people thinking about the future in this matter.

* upstream/master: Enable Merging of BibDatabases (#6689) Refactor file preferences (#6779) Interrupt all running tasks during shutdown (#6118) Fixes #6705 , added icon for multiple identifiers (#6809) Apply css files correctly to dialogs (#6828) Fix link Make template more explicit

calixtus added 4 commits August 23, 2020 23:58

Refactored for same basic clean-up and naming consistency

e5ea359

Refactored for more clean-ups and naming consistency

fac9f99

Refactored and extended AutoLinkPreferences

1fb6e7a

Refactored FilePreferences to immutable class

4147133

calixtus force-pushed the RefactorFilePreferences branch from d04a14a to 4147133 Compare August 23, 2020 21:59

calixtus added 6 commits August 24, 2020 13:09

Refactored two preferences from AutoLinkPreferences to FilePreferences

fd159fd

Moved import linked file patterns preferences to FilePreferencesTab

c90d621

Extended FilePreferences and refactored FileTab to use it

1dd6ffc

Checkstyle

416d8b7

Merge remote-tracking branch 'upstream/master' into RefactorFilePrefe…

acd5eb9

…rences # Conflicts: # src/main/java/org/jabref/preferences/JabRefPreferences.java # src/main/java/org/jabref/preferences/PreferencesService.java

Fixed merge error

edaed5e

calixtus added 2 commits August 31, 2020 20:39

Moved import-export preferences to exportSortingTab and renamed the tab

08bf760

Renamed FileTab to LinkedFilesTab

7e5ab69

Refactored ImportExportTab to PreferencesService

352417d

calixtus marked this pull request as ready for review August 31, 2020 20:38

calixtus changed the title ~~[WIP] Refactor file preferences~~ Refactor file preferences Aug 31, 2020

Siedlerchr reviewed Aug 31, 2020

View reviewed changes

CHANGELOG.md

83a05c1

Rewording ImportExport to File

1c00e7b

Make FilePreferences and SavePreferences mutable, added ADR

acc5646

Merge branch 'master' into RefactorFilePreferences

ce20c06

tobiasdiez merged commit 5ab494e into master Sep 1, 2020

tobiasdiez deleted the RefactorFilePreferences branch September 1, 2020 12:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor file preferences #6779

Refactor file preferences #6779

calixtus commented Aug 23, 2020 •

edited

Loading

github-actions bot commented Aug 23, 2020

github-actions bot commented Aug 31, 2020

calixtus commented Aug 31, 2020

Siedlerchr Aug 31, 2020

mlep commented Aug 31, 2020 •

edited

Loading

calixtus commented Aug 31, 2020

calixtus commented Aug 31, 2020

mlep commented Sep 1, 2020

calixtus commented Sep 1, 2020

mlep commented Sep 1, 2020

calixtus commented Sep 1, 2020

Refactor file preferences #6779

Refactor file preferences #6779

Conversation

calixtus commented Aug 23, 2020 • edited Loading

github-actions bot commented Aug 23, 2020

github-actions bot commented Aug 31, 2020

calixtus commented Aug 31, 2020

Siedlerchr Aug 31, 2020

Choose a reason for hiding this comment

mlep commented Aug 31, 2020 • edited Loading

calixtus commented Aug 31, 2020

calixtus commented Aug 31, 2020

mlep commented Sep 1, 2020

calixtus commented Sep 1, 2020

mlep commented Sep 1, 2020

calixtus commented Sep 1, 2020

calixtus commented Aug 23, 2020 •

edited

Loading

mlep commented Aug 31, 2020 •

edited

Loading