Redesign "Manage field names & content" dialog

[HoussemNasri]

Fixes #6536

Question: Looking at other dialogs in JabRef, I noticed a pattern where actions are always at the bottom of the dialog, but I can't seem to reformulate UI logic to follow that pattern. I think one solution could be to divide the UI across 2 dialogs. One for 'Edit field value of selected references' and another for 'Copy or move the value of one field to another'. What are your thoughts on this?

Automatic Field Editor

Overview

This PR aims to update the appearance & logic of the 'Manage field names & content' dialog. Although the problem seems trivial to solve, I had to make many decisions during the design phase, hence why I included user stories and acceptance criteria's.

User Stories

📗 Summary

As a user of JabRef

I want to clear one field in a collection of bib entries automatically

---

📗 Summary

As a user of JabRef

I want to change the value of one field in a collection of bib entries automatically

📋 Acceptance Criteria

Background

Given 'Manage field names & content' dialog is shown

Acceptance Criteria 1

When user enter an illegal value for the given field
Then show an error message

Acceptance Criteria 2

When user enter a legal value to be set for the specified field

And user clicks 'set field'

And 'Overwrite existing field values' checkbox is NOT selected

Then set the entered value to entries with the specified field empty

Acceptance Criteria 3

When user enter a legal value to be set for the specified field

And user clicks 'set field'

And 'Overwrite existing field values' checkbox is selected

Then set the entered value to all entries even if the specified field is not empty

---

📗 Summary

As a user of JabRef

I want to copy the value of one field to another field in a collection of bib entries automatically

📋 Acceptance Criteria

Background

Given 'Manage field names & content' dialog is shown

Acceptance Criteria 1

When the source and destination fields are not compatible (they don't hold the same type of data)
Then show an error message

Acceptance Criteria 2

When user attempt to copy the values of source field to destination field

And 'Overwrite Non empty field' is NOT selected

Then only update the destination field if it's empty

---

📗 Summary

As a user of JabRef

I want to move/cut the value of one field to another field in a collection of bib entries automatically

📋 Acceptance Criteria

Background

Given 'Manage field names & content' dialog is shown

Acceptance Criteria 1

When the source and destination fields are not compatible (they don't hold the same type of data)
Then show an error message

Acceptance Criteria 2

When 'Overwrite Non empty field' is NOT selected

Then disable the 'Move values' button

---

📗 Summary

As a user of JabRef

I want to append some value to one field in a collection of bib entries automatically

📋 Acceptance Criteria

Background

Given 'Manage field names & content' dialog is shown

Acceptance Criteria 1

When user enter an illegal value for the given field
Then show an error message

Acceptance Criteria 2

When 'Overwrite Non empty field' is NOT selected
Then disable 'Append value' button

---

📗 Summary

As a user of JabRef

I want to swap the values of two fields in a collection of bib entries automatically

📋 Acceptance Criteria

Background

Given 'Manage field names & content' dialog is shown

Acceptance Criteria 1

When 'Overwrite Non empty field' is NOT selected
Then disable 'swap values' button

Wireframe

Screenshots

💾 Technical Information

• We can use org.jabref.logic.integrity.FieldCheckers#getForField() to validate a field value.

.

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

[Siedlerchr]

Like the idea! I am just missing the option for renaming the field here? e.g.
In the current dialog, I can rename my existing field "title" to a field "customtitle" and in the biblatex source tab you see that title = { mytitle } got replaced with customtitle = { mytitle }.
Is this missing in your UI?

Regarding the Design:
We yesterday talked about the styling of the New Entry dialog and our solution was to come with tabs for example as seen in the library properties. This has a clear separation of tasks, and it also avoids long dialogs with much vertical size. This is especially often a problem for users with a small vertical screen size.

[HoussemNasri]

I am just missing the option for renaming the field here? e.g.
In the current dialog, I can rename my existing field "title" to a field "customtitle" and in the biblatex source tab you see that title = { mytitle } got replaced with customtitle = { mytitle }.

I think I misunderstood the rename button responsibility after reading the code comment below. But, since empty fields aren't stored then it makes perfect sense. So if I understand this correctly then renaming 'Move value' to 'Rename field' should solve it?

jabref/src/main/java/org/jabref/gui/edit/MassSetFieldsDialog.java

Lines 102 to 111 in 082e9cf

	* Move contents from one field to another for a Collection of entries.
	*
	* @param entries The entries to do this operation for.
	* @param field The field to move contents from.
	* @param newField The field to move contents into.
	* @param overwriteValues If true, overwrites any existing values in the new field. If false, makes no change for
	* entries with existing value in the new field.
	* @return A CompoundEdit for the entire operation.
	*/
	private static UndoableEdit massRenameField(Collection<BibEntry> entries, Field field, Field newField,

We yesterday talked about the styling of the New Entry dialog and our solution was to come with tabs for example as seen in the library properties.

Thank you; this looks way better than having 2 dialogs or putting everything in one. However, I had a look at 'Library properties' and it has no action buttons on the body. The only action button is 'Apply.'. Maybe we can update the dialog's buttons on tab switch?

[Siedlerchr]

I think we need to just distinguish the semantics here, although it's technically the same process:

1. Moving a value from A to B. e.g. the convert to biblatex moves the content of the field journal to journaltitle
2. Rename a field, for example mendeley-tags to mendeley_tags

Both are actually the same technically. Maybe just another button Rename Fields
Regarding the action button: You can just make it a "close button". See for example in Find unlinked files.

[HoussemNasri]

I created two action buttons: 'Keep Modifications' and 'Revert'. Clicking 'Keep Modifications' will save the modifications to UndoManager as a CompoundEdit (Thus users can undo them by clicking the undo arrow from the global bar), while clicking 'Revert' will undo all changes (Like you have never opened the dialog).

[HoussemNasri]

This PR has already grown larger than I expected. Some of the requirements, such as validating entered field values against selected field using FieldCheckers, will be left to another PR. I'd also like to write some test cases for the view models.

[Siedlerchr]

Lgtm in general, just some suggestion

[calixtus]

Thanks! Great addition to JabRef!

[ThiloteE]

Hey, just tried this. Overall I like it! I think I already found a bug though T.T

How to reproduce:

1. Add two entries

@Article{x1,
  a = {1},
  b = {2},
}

@Article{x2,
  b = {3},
}

2. Select both entries
3. Go to two fields tab
4. From a, To b; Enable Overwrite non empty fields; Press copy value

Result:

@Article{x1,
  a = {1},
  b = {1},
}

@Article{x2,
}

Expected:

@Article{x1,
  a = {1},
  b = {1},
}

@Article{x2,
  b = {3},
}

[HoussemNasri]

@ThiloteE Nice catch! I kind of expected it to be buggy at this stage. I'll be making another follow up PR to address this issue and other issues that may come up. I will also include test cases to help catch bugs faster.