Bring back content selectors

[koppor]

Introduction

JabRef 3.8.2

JabRef 3.8.2 had the possibility to use pre-defined words for the keyword field. Instead of auto-completion, the user could use a drop down field:

JabRef 5.12

In today's JabRef, there is no such possibility:

One can still configure the list where the user can choose the available "keywords" to offer.

On the left, the field is selected, on the right, the possible contents are shown.

Tasks

• Add the selection box next to the keyword field. The list should be filled with the contents of the content selectors list, minus the existing keywords.
  • This box is OUTSIDE the text box. It allows for selecting an item in a pre-defined list. Once a user clicks on the item, it is added alphabetically inside the list. In case the list is not alphabetically sorted, it is added to the end.
• In the configuration of the "Content Selectors", do NOT allow configuration of Fields having the property "org.jabref.model.entry.field.FieldProperty#PERSON_NAMES" (because there are soooo many authors, we think, it does not make sense to use it there)
• Change the popup to enter types to the combo box for custom entry types
  • old:
  • new:
• Optional: Rewrite the keyword edit to tags, also called chips
  • Use GemFX Tags Field (https://github.com/dlsc-software-consulting-gmbh/GemsFX#tags-field)
  • An example is implemented at Replaced abandoned JFoenix controls #10046

[Rohxn16]

i would like to work on this issue

[github-actions]

As a general advice for newcomers: check out Contributing for a start. Also, guidelines for setting up a local workspace is worth having a look at.

Feel free to ask here at GitHub, if you have any issue related questions. If you have questions about how to setup your workspace use JabRef's Gitter chat. Try to open a (draft) pull-request early on, so that people can see you are working on the issue and so that they can see the direction the pull request is heading towards. This way, you will likely receive valuable feedback.

[Satya-Manikanta]

Hi @koppor

In the org.jabref.gui.entryeditor.* folder,
I found the files for Required fields, Optional fields, Comments as well (as you can see I modifiled the tab name with the integer)
but I am not able to locate the file for General tab.

Can you please provide the steps or instructions on how General tab is being rendered in the UI.
And from which file we are getting the data for General tab shown in screenshot.

@Siedlerchr, @Rohxn16 if you do have idea on this, please provide your inputs

[koppor]

@Satya-Manikanta Understanding how the EntryEditor works is part of the levelling-up the code reading skills.

In org.jabref.gui.entryeditor.EntryEditor#createTabs, the routine after the "Comments" tab, there is the routine to fill the "General" tab. There, some magic is happening, because the content of that tab is configured in the preferences. The defaults are put at org.jabref.preferences.JabRefPreferences#setLanguageDependentDefaultValues.

[LoayGhreeb]

I would like to try to work on this issue.

@koppor, could you clarify how I can get the existing keywords to exclude them from the selection box? Should I split them by space, comma separator, or something else to be able to retrieve the words correctly?

[koppor]

I would like to try to work on this issue.

@koppor, could you clarify how I can get the existing keywords to exclude them from the selection box? Should I split them by space, comma separator, or something else to be able to retrieve the words correctly?

@LoayGhreeb Thank you for working on this. I didn't get that you are the one with the pull request. I will provide a more detailed answer later. I don't know all code by heart. One hint now: The separator is configured globally (called KeywordSeparator) and we have a class handling keywords (converting them to a list and back). Maybe you find it witj Ctrl+Shift+F.

[LoayGhreeb]

Hi @koppor, I have implemented most of the first task and the 3rd task is ready for review, I'm waiting for your feedback.

I have a small question regarding the first task. Do you want to check if all keywords in the text field are ordered alphabetically so that the selected item should be placed in the correct order? Otherwise, it will be added to the end.

[koppor]

@LoayGhreeb Let JabRef be smart here. In case the list is ordered alphabetically, add it alphabetically. Else: Add it to the end. That way, JabRef is "smart" and does not change an existing order.

[LoayGhreeb]

Let JabRef be smart here. In case the list is ordered alphabetically, add it alphabetically. Else: Add it to the end. That way, JabRef is "smart" and does not change an existing order.

Thanks for clarification @koppor, but since I will implement it using the Tags Field there is no need for this.

By the way, is this what is required in the second task?

Demo.mp4

[koppor]

Regardingthe second task. A user can configure the content selectors for fields:

My idea was to exclude field names which do not make sense to have content selectors. Not by name, but by property.

Maybe, it does not make sense. One would really need to think for which fields the content selectors would make sense. Much more work. The proposal with avoiding "PERSON" was a gut thing. Not well-thought...

[koppor]

Refined answer: If you are going to implement that - the combo box should just NOT contain some fields... No exception thrown.

[koppor]

but since I will implement it using the Tags Field there is no need for this.

I'm curious how this will be then... I hope, it won't resort the content. Let's see...