Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore error "Math superscript (^) and subscript (_) characters are not allowed in text mode" #11948

Open
koppor opened this issue Oct 13, 2024 · 8 comments
Labels
good first issue An issue intended for project-newcomers. Varies in difficulty.

Comments

@koppor
Copy link
Member

koppor commented Oct 13, 2024

Description

When checking https://github.com/JabRef/jabref/blob/main/src/test/resources/testbib/Chocolate.bib, one gets following integrity check error:

TTEM03: Math superscript (^) and subscript (_) characters are not allowed in text mode

Is a false postiive for Quality -> Check integrity

Task

  1. Modify org.jabref.logic.integrity.LatexIntegrityChecker#check to ignore error TTEM03 in the citation key (org.jabref.model.entry.field.InternalField#KEY_FIELD) when
  2. Add (at least) three test cases to org.jabref.logic.integrity.LatexIntegrityCheckerTest

Background

This is a follow-up to #10376


Example:

\documentclass{article}
\usepackage[style=authoryear,backend=biber]{biblatex}
\addbibresource{Chocolate.bib}

\title{Sample Document}
\author{Author Name}
\date{\today}

\begin{document}

\maketitle

\section{Introduction}

This is a citation example using \texttt{biblatex}. Here is a citation from our bibliography \cite{Corti_2009}.

\printbibliography

\end{document}

Output:

Image


I also tried with bibtex. Works.

@koppor koppor added the good first issue An issue intended for project-newcomers. Varies in difficulty. label Oct 13, 2024
@github-project-automation github-project-automation bot moved this to Free to take in Good First Issues Oct 13, 2024
@Kaven668
Copy link

Can I be work with this issue?

@ThiloteE ThiloteE moved this from Free to take to Assigned in Good First Issues Oct 13, 2024
@ThiloteE ThiloteE added the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Oct 13, 2024
Copy link
Contributor

Welcome to the vibrant world of open-source development with JabRef!

Newcomers, we're excited to have you on board. Start by exploring our Contributing guidelines, and don't forget to check out our workspace setup guidelines to get started smoothly.

In case you encounter failing tests during development, please check our developer FAQs!

Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on JabRef's Gitter chat. And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.

Happy coding! 🚀

@koppor koppor mentioned this issue Oct 24, 2024
7 tasks
@AmitKumarDeoghoria
Copy link

Is this issue still open? I would like to contribute . Can you please assign it to me.

@koppor
Copy link
Member Author

koppor commented Oct 25, 2024

Is this issue still open? I would like to contribute . Can you please assign it to me.

@AmitKumarDeoghoria Please use a proper browser and/or GitHub client to check the status of the issue.

I help you a bit by highlighting the important information:

Image

@koppor koppor moved this from Assigned to Free to take in Good First Issues Dec 3, 2024
@koppor koppor removed the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Dec 3, 2024
@Satyamkumarnavneet
Copy link

Hi @koppor, I would like to work on this. Could you please clarify which text mode does not allow Math superscript (^) and subscript (_) characters? I would appreciate your help in producing this issue for better understanding. Thank you!

@koppor
Copy link
Member Author

koppor commented Jan 16, 2025

Hi @koppor, I would like to work on this. Could you please clarify which text mode does not allow Math superscript (^) and subscript (_) characters? I would appreciate your help in producing this issue for better understanding. Thank you!

I would recommend you to use LaTeX at least once. See above for an MWE.

This project is sort of self-guided. We do not have the capacity to explain everyone the very basics of the context of our tool.

@Satyamkumarnavneet
Copy link

Hi @koppor, I would like to work on this. Could you please clarify which text mode does not allow Math superscript (^) and subscript (_) characters? I would appreciate your help in producing this issue for better understanding. Thank you!

I would recommend you to use LaTeX at least once. See above for an MWE.

This project is sort of self-guided. We do not have the capacity to explain everyone the very basics of the context of our tool.

Thanks for the guidance! I'll review all the resources and information to try and resolve the issue.

@Satyamkumarnavneet
Copy link

Hi @koppor, I’ve reviewed the resources and understood the context better. I’ve made the changes to ignore the superscript (^) and subscript (_) validation in citation keys. Could you please take a look at the pull request and let me know if everything looks good?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue An issue intended for project-newcomers. Varies in difficulty.
Projects
Status: Free to take
Development

No branches or pull requests

6 participants
@koppor @ThiloteE @Satyamkumarnavneet @AmitKumarDeoghoria @Kaven668 and others