Add hide button for user comments by koppor · Pull Request #10610 · JabRef/jabref

koppor · 2023-10-31T01:11:31Z

Fixes #10424 by adding a button.

By default the user comments will be shown. However, there is now a button to make it possible to hide the field.
It can be re-activated in the preferences.

This PR also refs https://github.com/JabRef/jabref-issue-melting-pot/issues/268 and makes use of the new JDK21 data structures. (See https://openjdk.org/jeps/431).

After pressing the button:

New preference option to re-enable:

I am not sure about the label "Add". Maybe "Add JabRef-featured user-specific comment"? Exact, but too long.

Alternatives considered:

Global preference to show the user-specific field --> too hidden for me - users won't find it
Library-specific setting to enable --> requires pro-users to setup the .bib file accordingly (and much more coding effort)

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.

- Place all user comments togehter (and BibTeX standard comment first) - Switch from Set to StructuredSet

tobiasdiez · 2023-10-31T02:24:39Z

I think this "add" functionality should go to the settings (probably in the form of a checkbox).

calixtus · 2023-10-31T06:27:47Z

I like the button. Makes the feature easier to find instead of looking in the prefs and activating, going back etc etc. Dynamically added, just missing a remove button now.

Label maybe "Add user comment"?

koppor · 2023-10-31T08:30:43Z

BTW nice that GitHub renders the arrow properly

tobiasdiez · 2023-10-31T09:12:54Z

Well, it would be as hidden (or as visible) as any other entry editor customization. Personally, I don't see why user comments should have a higher visibility than say adding/removing any other field. Feels rather inconsistent.

But anyway, it's also not that important. Could you please remove/decrease the whitespace below the button.

koppor · 2023-10-31T10:18:38Z

Whitespace: This is the best I could come up with. -- Without massive EntryEditor refactoring. Maybe you have an idea how to stack the button below the gridpane?

Priority: Debatable how to make features prominent and accessible in JabRef. Our welcome screen (for new users) is still a TODO. And this would be one item for it...

koppor · 2023-10-31T10:40:19Z

When working in group, someone might not want to add comments while others do

I'll add a preference to disable the feature

tobiasdiez · 2023-10-31T12:31:43Z

Whitespace: This is the best I could come up with. -- Without massive EntryEditor refactoring. Maybe you have an idea how to stack the button below the gridpane?

Negative bottom margin/padding?

Priority: Debatable how to make features prominent and accessible in JabRef. Our welcome screen (for new users) is still a TODO. And this would be one item for it...

My philosophy would be to present actual functionality to the users, and less so configuration options. Config options in the main view are only a good idea if you often need to switch between different options depending on context (e.g. union vs intersection select for groups, different toggles for search). For the user comments: If you don't use the feature, the button doesn't give you any value. If you do use the feature, then you are annoyed that you have to click the button every time.

I think it would make more sense for visibility if you write a nice documentation page with "consider these options if you work in a team".

calixtus · 2023-10-31T19:54:26Z

Negativ padding is the highway to ui hell.
Honestly, I think the whitespace gap is ok.

Siedlerchr · 2023-10-31T20:32:26Z

After thinking about I think it makes sense to show the user specific comment by default and then add a button: Hide comment with a notification that this can be re-activated in the prefs.
After the user clicked hide the button is no longer shown

* upstream/main: Update journal abbreviation lists (#10645) Use clparse (instead of heylogs) (#10641) Update CSL styles (#10642) Added parent field to Hayagriva YAML export (#10633) Bump org.fxmisc.richtext:richtextfx from 0.11.1 to 0.11.2 (#10637) Bump io.github.classgraph:classgraph from 4.8.163 to 4.8.164 (#10634) Bump org.junit.platform:junit-platform-launcher from 1.10.0 to 1.10.1 (#10635) Bump org.mockito:mockito-core from 5.6.0 to 5.7.0 (#10638) Bump com.tngtech.archunit:archunit-junit5-engine from 1.1.0 to 1.2.0 (#10636)

* upstream/main: App semantic scholar api key to properties (#10656) Replace cache: gradle with "odern" gradle-build-action (#10657) Clean up test code (#10658) Bump org.openrewrite.rewrite from 6.4.0 to 6.5.4 (#10650) Bump com.puppycrawl.tools:checkstyle from 10.12.4 to 10.12.5 (#10654) Bump com.fasterxml.jackson.dataformat:jackson-dataformat-yaml (#10653) Bump com.github.Dansoftowner:jSystemThemeDetector from 3.6 to 3.8 Remove comments - don't work on forks

remove from grid todo move to prefs

move entry editor preferences

Siedlerchr · 2023-11-27T20:29:21Z

Github currently has issues...

Siedlerchr · 2023-11-29T08:12:04Z

entry editor preferences needs to be mocked for gui test

koppor · 2023-12-04T10:17:49Z

Looks OK. However, user-specific comments not sorted well. The idea was to put the general comment field fiirst and then the user-specific comments. Currently, it is a mix:

first own-comments
then general comments
then comments from other users

It should be

first: general comments
then comments from other users and own - sorted by username.

Siedlerchr · 2023-12-04T10:25:53Z

Okay, I see what I can do

koppor · 2023-12-04T11:24:19Z

I see that a sorting of the comment field of the current user is hard.

Therefore, I implemented

first: general comments
second: user-specific comment (if enabled in the preferences - or non-empty)
third: all other non-empty user-specific comment fields

Note: We need to show non-empty user-specific comment fields - otherwise, they will be displayed in the bibtex source tab only.

With disabled show field:

With disabled show field - but with a comment

With enabled preferences

github-actions · 2023-12-04T17:19:42Z

The build for this PR is no longer available. Please visit https://builds.jabref.org/main/ for the latest build.

koppor added 2 commits October 31, 2023 02:07

Place BibTeX comment field first (and use JDK21 data structure)

9955f69

- Place all user comments togehter (and BibTeX standard comment first) - Switch from Set to StructuredSet

Enable "Add" button

0f913db

This was referenced Oct 31, 2023

User specific comment #9727

Merged

Not possible to disable user-specific comments #10424

Closed

Fix codestyle

7c54ed2

JabRef deleted a comment from github-actions Bot Oct 31, 2023

ThiloteE added the component: entry-editor label Nov 6, 2023

Siedlerchr added 4 commits November 11, 2023 16:39

Merge branch 'main' into fix-10424

c16ba35

Hide user comment button

9cef70d

remove from grid todo move to prefs

github-actions Bot reviewed Nov 26, 2023

View reviewed changes

Comment thread src/main/java/org/jabref/gui/entryeditor/CommentsTab.java

Siedlerchr added 2 commits November 27, 2023 20:14

Add new property for hiding/showing comment tabs

9ac66e8

move entry editor preferences

Add new property for hiding/showing comment tabs

9c5aead

move entry editor preferences

github-actions Bot reviewed Nov 27, 2023

View reviewed changes

Comment thread src/main/java/org/jabref/preferences/EntryEditorPreferences.java

Siedlerchr added 2 commits November 27, 2023 20:28

wire checkbox/button to preferences

c8e8110

fix checkstyle

327a2b9

Siedlerchr changed the title ~~Do not show user-specific comment as default~~ Add hide button for user comments Nov 27, 2023

calixtus reviewed Nov 27, 2023

View reviewed changes

Comment thread src/main/java/org/jabref/gui/entryeditor/CommentsTab.java Outdated

Move back

a48e0ee

fix

f1e3822

Merge branch 'main' into fix-10424

7850c13

fix test

4bce5f4

koppor and others added 3 commits December 4, 2023 12:27

Merge remote-tracking branch 'upstream/main' into fix-10424

6e4a677

Fix logic - and adapt tests

98e6f5f

Merge branch 'main' into fix-10424

cd521b5

Siedlerchr approved these changes Dec 4, 2023

View reviewed changes

Siedlerchr added this pull request to the merge queue Dec 4, 2023

Merged via the queue into main with commit 67e25a0 Dec 4, 2023

Siedlerchr deleted the fix-10424 branch December 4, 2023 20:20

koppor mentioned this pull request Mar 14, 2024

Make it easier to re-enable user comments #11021

Closed

Uh oh!

Conversation

koppor commented Oct 31, 2023 • edited by Siedlerchr Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Mandatory checks

Uh oh!

tobiasdiez commented Oct 31, 2023

Uh oh!

calixtus commented Oct 31, 2023

Uh oh!

koppor commented Oct 31, 2023

Uh oh!

tobiasdiez commented Oct 31, 2023

Uh oh!

koppor commented Oct 31, 2023

Uh oh!

koppor commented Oct 31, 2023

Uh oh!

tobiasdiez commented Oct 31, 2023

Uh oh!

calixtus commented Oct 31, 2023

Uh oh!

Siedlerchr commented Oct 31, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Siedlerchr commented Nov 27, 2023

Uh oh!

Siedlerchr commented Nov 29, 2023

Uh oh!

koppor commented Dec 4, 2023

Uh oh!

Siedlerchr commented Dec 4, 2023

Uh oh!

koppor commented Dec 4, 2023

Uh oh!

github-actions Bot commented Dec 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

koppor commented Oct 31, 2023 •

edited by Siedlerchr

Loading

github-actions Bot commented Dec 4, 2023 •

edited

Loading