User specific comment #9727

NiD133 · 2023-04-02T14:35:07Z

Fixes #543

Compulsory checks

Give feedback

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.
Options

koppor · 2023-04-04T06:03:29Z

If possible, the new editor should also support editing org.jabref.model.entry.BibEntry#commentsBeforeEntry

koppor

A good start 👍

Test cases are missing.

koppor · 2023-04-04T06:05:38Z

src/main/java/org/jabref/model/entry/field/UserSpecificCommentField.java

+
+public class UserSpecificCommentField implements Field {
+    private final String name;
+    private final Set<FieldProperty> properties;


This can be static final

src/main/java/org/jabref/model/entry/field/UserSpecificCommentField.java

koppor · 2023-04-04T06:08:20Z

src/main/java/org/jabref/gui/entryeditor/OtherFieldsTab.java

-            Set<Field> otherFields = entry.getFields().stream().filter(field -> !allKnownFields.contains(field)).collect(Collectors.toCollection(LinkedHashSet::new));
-
+            Set<Field> otherFields = entry.getFields().stream()
+                                          .filter(field -> !allKnownFields.contains(field) && !field.getName().toLowerCase().contains("comment"))


It should be startsWith and comment-, because UserSpecificCommentField.java is implemented like that.

Maybe also check for plain comment in addition.

Why does the following not work here?

(that code is from above)

field -> field.equals(StandardField.COMMENT) || field instanceof UserSpecificCommentField

src/main/java/org/jabref/gui/entryeditor/EntryEditor.java

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

CHANGELOG.md

…_specific_comment

Siedlerchr · 2023-05-06T17:17:25Z

Please have a look at the failing unit tests, most of them are related to the l10n https://devdocs.jabref.org/code-howtos/localization.html

NiD133 · 2023-05-20T22:29:52Z

Please have a look at the failing unit tests, most of them are related to the l10n https://devdocs.jabref.org/code-howtos/localization.html
Got it! Working on it right now.

Siedlerchr · 2023-05-23T17:35:40Z

Please have a look at the failing tests!

Siedlerchr · 2023-06-03T21:24:57Z

Thanks for the continuing work here! What is the current status`Is this ready from your side? Anything left or unclear?

NiD133 · 2023-06-04T01:30:46Z

Thanks for the continuing work here! What is the current status`Is this ready from your side? Anything left or unclear?

Yeah, I believe it's ready from my side. If there are any further changes or clarifications needed, please let me know. :)

koppor · 2023-06-06T05:47:09Z

I made updates:

Merge "All Comments" into "Comments" tab. Thereby modifying the logic of the entry editor to prioritize the code over user-configuration 😇
Add more tests

koppor · 2023-06-06T05:48:12Z

In principle, this works. If one modifies the BibTeX source code, one has to switch to another entry and back to get the change updated in the Comments tab. I did not see an easy solution for this. Thus, it is good to go from my side!

NiD133 · 2023-06-06T10:31:35Z

I made updates:

Merge "All Comments" into "Comments" tab. Thereby modifying the logic of the entry editor to prioritize the code over user-configuration 😇

Add more tests

Got it!

Siedlerchr · 2023-06-06T13:38:48Z

Thanks a lot for this cool feature!

koppor · 2023-10-31T01:49:42Z

What we oversaw during review: Ordering of fields.

First, the bibtex standard field should come, then the user-specific comment fields. Since they are mixed, users are very confused and angry (see #10424). - I don't remember any other occasion where we have three thumbs ups ^^

I tried to fix it at #10610.

Just as information to @NiD133 if you work on UX in the future in other projects.

* upstream/main: (68 commits) Fix issue 9863 - Change Tab selection order (#9907) New Crowdin updates (#9994) Enable editing typo with double clicking on field name in custom entry type (#9977) Remove "Field name:" from localization - we already have "Field name" (#9991) Changed database to catalog in org.jabref.gui.slr and org.jabref.logic.crawler (#9989) Use environment variables for hostname detection (#9910) Add cleanup activity for URL field (#9970) Fix freezing when fetching IBSN and no results are found (#9987) Make Group(Node)TreeViewModel more OO (#9978) Fix container for group item count still visible if display count is off (#9980) Fix paste of BibTeX data (#9985) Bring back SimplifyBoolean* and UnnecessaryParantheses (and refine guide) (#9981) Add new menu entry to remove braces from selection, aka unprotect it. (#9968) User specific comment (#9727) Bump org.openrewrite.recipe:rewrite-recipe-bom from 1.19.3 to 2.0.0 (#9975) Fix typos Remove non-needed link Fix typos Enable RemoveJavaDocAuthorTag (#9973) Bump com.fasterxml.jackson.datatype:jackson-datatype-jsr310 (#9974) ...

NiD133 and others added 12 commits April 1, 2023 19:51

Create user specific comment field

25180f8

User can make user-specific comments

c9abf69

User specific comment will not display in other fields

27cffa6

Refactor the code

56aba71

Make changes

b467264

Make changes

29fb2d0

Force to make user specific comments

14e8b6d

Fix error

18bc42b

Test if to show the other user's comments

2337579

Delete useless code

a70f5d2

Add changes in CHANGELOG

248cf4f

Merge branch 'main' into user_specific_comment

e3c988a

Merge branch 'main' into user_specific_comment

7c390fb

koppor requested changes Apr 4, 2023

View reviewed changes

ThiloteE added the entry-editor label Apr 4, 2023

NiD133 added 4 commits April 5, 2023 22:14

Make changes only author can edit user specific comment

115c7e3

Merge remote-tracking branch 'origin/user_specific_comment' into user…

86d284d

…_specific_comment

Specify the user specific comment does not belong to current user

0be6fe2

Add test case for comments tab

fd362e9

koppor mentioned this pull request Apr 27, 2023

Sanitize library file during import: ' #9582

Open

Siedlerchr added the status: changes required Pull requests that are not yet complete label May 6, 2023

Refactor code based on the feedback

4410553

NiD133 and others added 4 commits May 24, 2023 16:51

Refactor tests about the CommentsTab

f023fec

Add missing localization keys in the English language file.

8d76630

Merge branch 'main' into user_specific_comment

1a8a5b6

Modify the failing checkstyle tests

7f2e445

Additional logic to parseField to better handle user specific comment.

87947d1

Fetch the username using PreferencesService to improve simplicity.

66f945a

Merge branch 'main' into user_specific_comment

2d3ac52

koppor force-pushed the user_specific_comment branch 2 times, most recently from 30e01c4 to 0d7da65 Compare June 6, 2023 05:26

koppor added 5 commits June 6, 2023 07:26

Merge "All-Comments" into tab "Comments"

0d7da65

Minor code beautification

7d2099b

Simplify tests (and add one more test)

e1bf03a

Always list "Comment" field

0abf13b

Refine CHANGELOG entry

9d07247

Remove tool tip (not containing much additional information)

5ecb0e6

koppor approved these changes Jun 6, 2023

View reviewed changes

koppor added status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers status: changes required Pull requests that are not yet complete and removed status: changes required Pull requests that are not yet complete labels Jun 6, 2023

koppor marked this pull request as ready for review June 6, 2023 06:09

koppor removed the status: changes required Pull requests that are not yet complete label Jun 6, 2023

Siedlerchr approved these changes Jun 6, 2023

View reviewed changes

Siedlerchr merged commit 76e2ce7 into JabRef:main Jun 6, 2023

koppor mentioned this pull request Jun 14, 2023

A user comment is now multi line #10012

Merged

6 tasks

tobiasdiez mentioned this pull request Sep 27, 2023

Not possible to disable user-specific comments #10424

Closed

2 tasks

koppor mentioned this pull request Mar 12, 2024

Remove obsolete "Comments" tab configuration #11011

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User specific comment #9727

User specific comment #9727

NiD133 commented Apr 2, 2023

Compulsory checks

koppor commented Apr 4, 2023

koppor left a comment

koppor Apr 4, 2023

koppor Apr 4, 2023

koppor Apr 4, 2023

Siedlerchr commented May 6, 2023

NiD133 commented May 20, 2023

Siedlerchr commented May 23, 2023

Siedlerchr commented Jun 3, 2023

NiD133 commented Jun 4, 2023

koppor commented Jun 6, 2023 •

edited

Loading

koppor commented Jun 6, 2023

NiD133 commented Jun 6, 2023

Siedlerchr commented Jun 6, 2023

koppor commented Oct 31, 2023

User specific comment #9727

User specific comment #9727

Conversation

NiD133 commented Apr 2, 2023

Compulsory checks

koppor commented Apr 4, 2023

koppor left a comment

Choose a reason for hiding this comment

koppor Apr 4, 2023

Choose a reason for hiding this comment

koppor Apr 4, 2023

Choose a reason for hiding this comment

koppor Apr 4, 2023

Choose a reason for hiding this comment

Siedlerchr commented May 6, 2023

NiD133 commented May 20, 2023

Siedlerchr commented May 23, 2023

Siedlerchr commented Jun 3, 2023

NiD133 commented Jun 4, 2023

koppor commented Jun 6, 2023 • edited Loading

koppor commented Jun 6, 2023

NiD133 commented Jun 6, 2023

Siedlerchr commented Jun 6, 2023

koppor commented Oct 31, 2023

koppor commented Jun 6, 2023 •

edited

Loading