Allow manual entry of keywords with escaped delimiters

[BOgdAnSAM-sudo]

Is your suggestion for improvement related to a problem? Please describe.

When I was working on #12810, I noticed that it isn't possible to manually enter a keyword containing an escaped delimiter; it works only if I paste the whole keyword.

For example, when I try to create the single keyword "keyword1, keyword2", as soon as I type "keyword1\,", a new keyword "keyword1\" is created. If I continue typing "keyword2", I end up with two separate keywords: "keyword1\" and "keyword2". However, if I paste the string "keyword1\, keyword2", it behaves as expected and creates a single keyword.

This happens due to logic in org/jabref/gui/fieldeditors/KeywordsEditor;

jabref/jabgui/src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

Lines 124 to 130 in 97d548a

	String keywordSeparator = String.valueOf(viewModel.getKeywordSeparator());
	keywordTagsField.getEditor().setOnKeyReleased(event -> {
	if (event.getText().equals(keywordSeparator)) {
	keywordTagsField.commit();
	event.consume();
	}
	});

it checks every symbol that is typed into the field, and if this symbol is a delimiter, it automatically commits the new keyword.

I believe this is confusing for the user and defeats the purpose of the reworked keyword parsing logic.

Describe the solution you'd like
I have two ideas on how to resolve this issue:

1. Remove the auto-commit logic from KeywordsEditor altogether, so the user must press Enter to create a new keyword.
2. Enhance the logic in KeywordsEditor to check if the separator was escaped before committing the keyword.

[Priyansh2100]

Hi @BOgdAnSAM-sudo ,

I have fix the issue , Please find the below attached code .

String keywordSeparator = String.valueOf(viewModel.getKeywordSeparator());
keywordTagsField.getEditor().setOnKeyReleased(event -> {
if (event.getText().equals(keywordSeparator)) {

    String currentText = keywordTagsField.getEditor().getText();
    int caretPosition = keywordTagsField.getEditor().getCaretPosition();
   
    boolean isEscaped = false;
    if (caretPosition >= 2 && currentText.length() >= caretPosition) {
        int backslashCount = 0;
        int pos = caretPosition - 2; // Position before the separator
        while (pos >= 0 && currentText.charAt(pos) == '\\') {
            backslashCount++;
            pos--;
        }
        isEscaped = (backslashCount % 2) == 1;
    }
    
    if (!isEscaped) {
        keywordTagsField.commit();
        event.consume();
    }
}

});

the fix :
Detects when a separator character is typed
Counts consecutive backslashes immediately before the separator
Commits only if the separator is not escaped (even or zero backslashes)
Skips commit if the separator is escaped (odd number of backslashes)

[Preetam1804]

Hi @BOgdAnSAM-sudo ! I’d like to work on this. For the expected behavior, should we keep auto-commit and add escape-handling, or remove auto-commit entirely and require Enter? Which direction should I implement?

[BOgdAnSAM-sudo]

Hi Preetam1804. I'm not sure which approach is better, but I would personally go with first one.

should we keep auto-commit and add escape-handling, or remove auto-commit entirely and require Enter?

Actually, I wouldn't recommend working on this issue right now. I'm relatively new to JabRef and not 100% certain if this feature should be implemented and how. Better wait until one of the maintainers approves it.

[Preetam1804]

Thanks for the clarification @BOgdAnSAM-sudo !
I will wait until the maintainer makes a decision.

[koppor]

With the fix of #12810 this should already work. If not, its a but. Go ahead and fix it.

[koppor]

• Please also take into consideration the hierarchical keywords: The new tag system ignores hierarchical keywords. Only the parent keyword is shown. #11390
• Please add requirements to docs/requirements and link the implentation

[BOgdAnSAM-sudo]

/assign-me

[jabref-machine]

⚠️ Self-Assignment Not Allowed

Hi @BOgdAnSAM-sudo, you cannot self-assign an issue you created.

Note

This project requires maintainer approval before working on self-created issues to ensure alignment with the project roadmap.

What you can do

• Wait for a maintainer to review and approve your issue
• Ask a maintainer to assign you if the issue is approved
• Look for other existing issues to contribute to