Fix: Ignore "Math superscript (^) and subscript (_) characters are not allowed in text mode" error for citation key (#11948) #12391
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.
In case of issues with the import order, double check that you activated Auto Import.
You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.
| // Ignore checks for the citation key field | ||
| .filter(field -> !(field.getKey().equals(InternalField.KEY_FIELD) && field.getValue().matches(".*[\\^_].*"))) |
There was a problem hiding this comment.
No. Please take "nore error TTEM03" of the task description serious.
There was a problem hiding this comment.
Hi @koppor, Thanks for the feedback! Could you share any suggestions on how to better address the TTEM03 handling?
| Arguments.of(LatexIntegrityChecker.errorMessageFormatHelper(CoreErrorCode.TTEM03), StandardField.TITLE, "Title with ^ and _ characters"), | ||
| // Ensure invalid LaTeX syntax with special characters in other fields is detected | ||
| Arguments.of(LatexIntegrityChecker.errorMessageFormatHelper(CoreErrorCode.TTEM03), StandardField.AUTHOR, "Author_Name"), | ||
| Arguments.of(LatexIntegrityChecker.errorMessageFormatHelper(CoreErrorCode.TTEM03), StandardField.JOURNAL, "Journal_Name"), | ||
| Arguments.of(LatexIntegrityChecker.errorMessageFormatHelper(CoreErrorCode.TTEM03), StandardField.BOOKTITLE, "Book^Title"), | ||
| Arguments.of(LatexIntegrityChecker.errorMessageFormatHelper(CoreErrorCode.TTEM03), StandardField.NOTE, "Note_with_subscript_and_superscript^_") |
There was a problem hiding this comment.
OK, but you did not test for org.jabref.model.entry.field.InternalField#KEY_FIELD, where you changed the behavior.
There was a problem hiding this comment.
Thanks for pointing that out! I've added a new test case for InternalField.KEY_FIELD, but it's currently failing.
| Arguments.of(LatexIntegrityChecker.errorMessageFormatHelper(CoreErrorCode.TTEM03), StandardField.JOURNAL, "Journal_Name"), | ||
| Arguments.of(LatexIntegrityChecker.errorMessageFormatHelper(CoreErrorCode.TTEM03), StandardField.BOOKTITLE, "Book^Title"), | ||
| Arguments.of(LatexIntegrityChecker.errorMessageFormatHelper(CoreErrorCode.TTEM03), StandardField.NOTE, "Note_with_subscript_and_superscript^_") | ||
|
|
There was a problem hiding this comment.
Thank you for the feedback! I’ll make sure to take care of this next time.
There was a problem hiding this comment.
Your code currently does not meet JabRef's code guidelines.
We use OpenRewrite to ensure "modern" Java coding practices.
The issues found can be automatically fixed.
Please execute the gradle task rewriteRun, check the results, commit, and push.
You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".
|
Hi @koppor, I have addressed all feedback and made the necessary changes. Could you please review the updates at your convenience? Thank you! |
This pull request addresses the issue #11948 of false positive integrity check errors for citation keys containing superscript (
^) and subscript (_) characters in text mode. Specifically:LatexIntegrityChecker#checkto:TTEM03forInternalField.KEY_FIELD.^or_are ignored during validation.TITLE,AUTHOR,JOURNAL,BOOKTITLE,NOTE) are still checked for invalid LaTeX syntax.Mandatory checks
CHANGELOG.mddescribed in a way that is understandable for the average user (if change is visible to the user)