Limit group separator to one single character in Prefs dialog

[matthiasgeiger]

JabRef version 3.7dev

While investigating JabRef#2184 I noticed that the keyword separator is stored as a String in the prefs, but using the accessor method just returns the first character:

    public Character getKeywordDelimiter() {
        return get(KEYWORD_SEPARATOR).charAt(0);
    }

(see JabRefPreferences.java)

Prefs dialog for groups should be adjusted that it is only possible to insert a single character as delimiter.

[kdaud]

Hey, I want to work on this issue. Any description on how to reproduce the bug?

[koppor]

1. Understand what is meant by "Prefs dialog".

• Hint 1: "Prefs" is the short form for "preferences.
• Hint 2: Search the docs. You won't find a help page on preferences, but on options
• Hint 3: Start JabRef (e.g., by executing gradlew run)

You will find

• Hint 4: Use Ctrl+Shift+F in IntelliJ to do a full text search on the code
• Hint 5: Search for "Keyword separator"

(It gets late here, I hope the hints will guide you in the right direction)

[colinldbd]

Hi, I'm a new contributor! And I'm very interested in this issue. Can you assign this issue to me so I can work on it? I'm also reading through the contributing guide and found this in one of the good first issues. I'd like to work on it and give it a go.

Many thanks!

[koppor]

@colinldbd This is your second issue. Have fun working on it!

[colinldbd]

1. Understand what is meant by "Prefs dialog".

• Hint 1: "Prefs" is the short form for "preferences.
• Hint 2: Search the docs. You won't find a help page on preferences, but on options
• Hint 3: Start JabRef (e.g., by executing gradlew run)

You will find

• Hint 4: Use Ctrl+Shift+F in IntelliJ to do a full text search on the code
• Hint 5: Search for "Keyword separator"

(It gets late here, I hope the hints will guide you in the right direction)

@koppor Hi, while trying to reproduce the problem, I noticed there's already some changes made to the preference panel.

In your screenshot, there's an keyword seperator input box in the Preference->Group, however, in the latest version of the repo, that keyword separator has already been moved to the Preference->Entry instead of being in Preference->Group.

But the documentation for JabRef is still not updated.
See the documentation for Group:
Documentation for Group

I'll still be looking into this issue to see whether the original issue still exists, however maybe we should update our documentation for this?
It's a little bit confusing because the documentation doesn't match the actual current GUI for JabRef.

I see the problem might still exist, but it's moved here:

I'll look into it further.

Many thanks!

[colinldbd]

Hi, also I opened a new issue for the documentation dismatch.
issue##10542

[colinldbd]

Hi, @koppor @matthiasgeiger, I've already created a PR about this problem Limit group separator to one single character in Prefs->Entry Keyword Separator JabRef/jabref#10543 thank you for assigning it to me.

[koppor]

It's a little bit confusing because the documentation doesn't match the actual current GUI for JabRef.

@colinldbd This is a consequence that all of our work in JabRef is volunteering work. We cannot catch up on everything here. We rely on contributors like you. I think, with JabRef/user-documentation#468 you already went half the way. - You could even take that as change to check out the new docuemtation IDE of JetBrains (https://www.jetbrains.com/writerside/)

[ThiloteE]

I assume this issue was fixed by JabRef#10543, thereby closing.