Add CSS Customisation #6725

calixtus · 2020-07-30T22:01:37Z

This PR continues the abandoned PR #6036
As discussed in the DevCall, we are now aggressivly finishing those PRs we would like to include in JabRef.
Works so far, yet I still want to make some changes with the optics...
Introduces also AppearancePreferences

(Screenshots are out of date, see below)

fixes #5790

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.

… CSS file, started on import functionality

…d of string concatenation

…ve since we don't need it

* Add CSS file type, add button in preferences to import a custom CSS file, started on import functionality * Change so that the log uses format specifiers instead of string concatenation * Add RadioButton for toggling custom theme * Add preference for setting the path to custom CSS theme * Load custom CSS if toggled * Add missing language keys * Remove check if the current theme is applied again, the check is removed since we don't need it * Save path to the custom CSS file in program preferences

… once, disable custom theme radio button i no custom theme has been imported

* Add method for saving theme to file * Add modal for selection witch theme to export as CSS

…2/jabref into DD2480-Group-22-addCSSCustomisation

Siedlerchr · 2020-07-31T06:58:31Z

As you are working on that theme and preferences stuff, maybe you can also check for this issue/PR? #6429

tobiasdiez · 2020-08-01T07:20:49Z

I don't really see the value in the export button. Instead I would focus more on a good documentation on how to create a custom theme, linking the main and dark.css in our repo. Or do I miss something?

calixtus · 2020-08-01T10:22:49Z

To be honest, I don't see any advantage in the export button too, but in the first step I just wanted to preserve the effort the students put in it and to address the raised issues in the predecessor PR. Now I'm thinking about how to improve it. So ideas are welcome.

Btw. We should really think of cleaning up our css-files and to distinguish between changeable stuff and unchangeable. This is kind of messed up atm all through the codebase...

tobiasdiez · 2020-08-01T12:00:06Z

Ok, then I would propose to remove the export dialog - also makes the implementation more streamlined.

Not sure what you mean with "changeable" vs "non-changable" in the css code. I think themes can override everything.

calixtus · 2020-08-01T13:11:38Z

There are many specialized css files eg for the entry editor, for the preferences dialog, for the groups (I think I remember), partially because we do some detail styling in these specialized css files, which are not customizable.

calixtus · 2020-08-12T14:43:28Z

I took some time to debug the issue in #6429
I tried to introduce a listener

EasyBind.wrapNullable(dialogPaneProperty()).subscribe(pane ->
                Globals.getThemeLoader().installCss(getDialogPane().getScene(), Globals.prefs));

in the BaseDialog constructor. The problem seems to be, that Java only calls the subscriber when already this dialog was opened before. So it works, but only on the second attempt. Strange... Maybe @Siedlerchr has a clue. But since this issue is not directly connected to this PR I suggest we follow it in #6429. Also i noticed, we have to make the controls dependend on the selected font size, since they wont be displayed properly if the font size is increased.

Therefor this PR should be ready review.

tobiasdiez

Nice work! Looks good to me. I've one or two minor remarks, and a couple more suggestions.

tobiasdiez · 2020-08-12T20:22:32Z

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

+        fontOverrideProperty.setValue(initialAppearancePreferences.shouldOverrideDefaultFontSize());
+        fontSizeProperty.setValue(String.valueOf(initialAppearancePreferences.getMainFontSize()));
+
+        String currentTheme = initialAppearancePreferences.getPathToTheme();


I'm not sure if this makes things clearer, but just wanted to throw the idea in: What about having an enum for the different kinds of themes (light / dark / custom), and then an additional Path getPathToCustomTheme in case the "custom" enum option is chosen. Right now it feels like getPathToTheme is mixing these two aspects.

Yeah, possible, but It escalated a bit. Again. 🙈

src/main/java/org/jabref/gui/util/ThemeLoader.java

tobiasdiez · 2020-08-12T20:27:46Z

src/main/java/org/jabref/preferences/PreferencesService.java

@@ -70,6 +70,8 @@

    void setWorkingDir(Path dir);

+    String setLastPreferencesExportPath();


Is this still needed?

Partly. I would like to postpone refactor of this until later when I'm working on FilePreferences.

…vmOption

tobiasdiez · 2020-08-14T05:52:55Z

src/main/java/org/jabref/gui/util/Theme.java

+        this.additionalCssPath = Path.of(path);
+    }
+
+    public static void initialize(FileUpdateMonitor fileUpdateMonitor, PreferencesService preferences) {


To be honest, I'm not a big fan of these static methods. Static methods should only be used when there is no internal state to manage. So for example its ok that the methods in StringUtil are static, as they mostly follow the pattern that they take an input, process it and return something.

However, here, there is a state that is managed: the fileUpdateMonitor and the additionalCssToLoad private fields. This leads to the hidden convention, that it's only allowed to call the installCss method after initalize is called. It's better to make this requirement explicit by making initalize a constructor of a normal class. This also has the advantage that you can mock/replace the themeloader in tests or for whatever reason. (I agree that it's somewhat academic in this particular case for the themeloader, as its not widely used. But it's good to follow the practice that dependencies are explicitly stated and not hidden in untestable static classes).

Ok, I have reworked the class, the static objects are now part of the theme object. Should feel now somewhat like a cell factory with 'fluent' api (getTheme().installCss(scene)). The fileUpdateMonitor dependency is still bound to the Globals object, but I did not have the time nor the energy to refactor everything now, so I would like to stop here and to leave the refactor of the Globals object for sometime later, as I really would like to finish the preferences refactor project first.

…ddCSSCustomisation

github-actions · 2020-08-19T17:09:27Z

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.

Marcel Luethi
Nils Streijffert
Qing
ShiqingLiu
WangAooa

github-actions · 2020-08-31T14:58:22Z

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

* upstream/master: (120 commits) Follow up fix for copy paste (#6820) Add CSS Customisation (#6725) Separate signing and notarizing (#6822) Remove checkstyle hack. 8.36 got released (#6816) Feature/enable lucene query parsing (#6799) New release cycle Bump WyriHaximus/github-action-wait-for-status from v1.1.2 to v1.2 (#6814) Bump mockito-core from 3.5.5 to 3.5.7 (#6813) Bump classgraph from 4.8.87 to 4.8.89 (#6812) Bump me.champeau.gradle.jmh from 0.5.0 to 0.5.1 (#6811) Bump checkstyle from 8.35 to 8.36 (#6810) Improve Changelog Refactor edit action (#6808) Fixed typo in BuildInfo (#6807) disable checkstyle for generated fix checkstyle Simplify check-links.yaml (markdown-link-check) (#6720) Rename /gen to /generate (#6800) Disable CSL refresh on push (#6803) New Crowdin updates (#6804) ... # Conflicts: # src/main/java/org/jabref/gui/JabRefFrame.java

nilsstre and others added 26 commits February 26, 2020 11:45

feat/#1 Add CSS file type, add button in preferences to import custom…

f402fd2

… CSS file, started on import functionality

feat/#1 Change so that the log messages uses format specifiers instea…

7bf2fed

…d of string concatenation

feat/#1 Add RadioButton for toggling custom theme

b27f26d

feat/#1 Add preference for setting path to custom CSS theme

8cb3a50

feat/#1 Load custom CSS if toggled

bd6c561

feat/#1 Add missing language keys

6a5f73c

feat/#1 Remove check if current theme is applied again, check is remo…

b5b56bf

…ve since we don't need it

feat/#1 Save path to custom CSS file in program preferences

99d9768

fix/#5 Add checks so that the theme change notification is only shown…

f2fc2ab

… once, disable custom theme radio button i no custom theme has been imported

Fix merge conflict, fixes #5

582c9d5

Remove added stuff from merge conflict

198be47

Add export current theme #5790

00eac4e

* Add method for saving theme to file * Add modal for selection witch theme to export as CSS

Add missing language lines

9fc3382

Merge branch 'master' into addCSSCustomisation

90fc805

Add information about import/export of themes, #5790

4f0db24

Fix CodaCy and checkstyle issues, #5790

a8feb94

Add fixes from code review, #5790

8c1e2c2

Remove unused import #5790

e4a4f68

Move the import/export buttons to the Appearance tab #5790

00d8ef6

Merge branch 'addCSSCustomisation' of git://github.com/DD2480-Group-2…

0be1309

…2/jabref into DD2480-Group-22-addCSSCustomisation

Fixed merge errors

04f905c

Fixed easy remarks

dcb355a

Introduced AppereancePreferences and changed some visual elements

c9a8a95

Refactored ExportThemeDialog

c700bc3

Fixed merge error

1503dbf

calixtus added ui preferences labels Jul 30, 2020

calixtus mentioned this pull request Jul 30, 2020

Let user load customized CSS #6036

Closed

4 tasks

Removed export theme logic and added validation

0b2f2ca

calixtus marked this pull request as ready for review August 12, 2020 14:43

calixtus added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Aug 12, 2020

calixtus changed the title ~~[WIP] Add CSS Customisation~~ Add CSS Customisation Aug 12, 2020

calixtus added 2 commits August 12, 2020 16:57

CHANGELOG.md

2d2011a

Removed obsolete viewmodel class

487e24c

tobiasdiez requested changes Aug 12, 2020

View reviewed changes

calixtus added 3 commits August 13, 2020 16:40

Refactored io.File to nio.Path, use of JabRefPreferences and removed …

1a955d8

…vmOption

Refactored ThemeLoader object class to enum with static util methods

ac3eb81

Fixed overlooked merge error

89ef86f

tobiasdiez reviewed Aug 14, 2020

View reviewed changes

calixtus added 2 commits August 15, 2020 15:08

Refactored static methods to object methods

411ee11

Checkstyle

3f0e98d

Siedlerchr added the status: changes required Pull requests that are not yet complete label Aug 18, 2020

calixtus mentioned this pull request Aug 18, 2020

Attempt to fix the issue #6039 Font size increase does not increase preferences font size #6429

Closed

5 tasks

calixtus added 2 commits August 19, 2020 18:30

Merge remote-tracking branch 'upstream/master' into DD2480-Group-22-a…

fd55cda

…ddCSSCustomisation

Merge remote-tracking branch 'upstream/master' into DD2480-Group-22-a…

189579d

…ddCSSCustomisation

calixtus mentioned this pull request Aug 22, 2020

Change the line spacing in table and groups #6743

Closed

Siedlerchr approved these changes Aug 31, 2020

View reviewed changes

Merge branch 'master' into CSSCustomisation

278b3e9

Siedlerchr merged commit 43c8ba2 into master Aug 31, 2020

Siedlerchr deleted the CSSCustomisation branch August 31, 2020 14:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CSS Customisation #6725

Add CSS Customisation #6725

calixtus commented Jul 30, 2020 •

edited

Siedlerchr commented Jul 31, 2020

tobiasdiez commented Aug 1, 2020

calixtus commented Aug 1, 2020 •

edited

tobiasdiez commented Aug 1, 2020

calixtus commented Aug 1, 2020

calixtus commented Aug 12, 2020 •

edited

tobiasdiez left a comment

tobiasdiez Aug 12, 2020

calixtus Aug 13, 2020

tobiasdiez Aug 12, 2020

calixtus Aug 13, 2020

tobiasdiez Aug 14, 2020

calixtus Aug 15, 2020 •

edited

github-actions bot commented Aug 19, 2020

github-actions bot commented Aug 31, 2020

		@@ -70,6 +70,8 @@

		void setWorkingDir(Path dir);

		String setLastPreferencesExportPath();

Add CSS Customisation #6725

Add CSS Customisation #6725

Conversation

calixtus commented Jul 30, 2020 • edited

Siedlerchr commented Jul 31, 2020

tobiasdiez commented Aug 1, 2020

calixtus commented Aug 1, 2020 • edited

tobiasdiez commented Aug 1, 2020

calixtus commented Aug 1, 2020

calixtus commented Aug 12, 2020 • edited

tobiasdiez left a comment

Choose a reason for hiding this comment

tobiasdiez Aug 12, 2020

Choose a reason for hiding this comment

calixtus Aug 13, 2020

Choose a reason for hiding this comment

tobiasdiez Aug 12, 2020

Choose a reason for hiding this comment

calixtus Aug 13, 2020

Choose a reason for hiding this comment

tobiasdiez Aug 14, 2020

Choose a reason for hiding this comment

calixtus Aug 15, 2020 • edited

Choose a reason for hiding this comment

github-actions bot commented Aug 19, 2020

github-actions bot commented Aug 31, 2020

calixtus commented Jul 30, 2020 •

edited

calixtus commented Aug 1, 2020 •

edited

calixtus commented Aug 12, 2020 •

edited

calixtus Aug 15, 2020 •

edited