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

Script adds highlights in special environments #6

Open
osanstrong opened this issue Aug 27, 2024 · 0 comments
Open

Script adds highlights in special environments #6

osanstrong opened this issue Aug 27, 2024 · 0 comments
Assignees
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:1-Critical This is the highest priority (i.e. it is blocking other work or facing a deadline). Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Bug Something is wrong or broken. This issue or PR is related to a bug in code.

Comments

@osanstrong
Copy link
Collaborator

Currently, the script does not differentiate between conventional text and certain special environments (e.g. \subsection{}, \newacronym{}{}{}) when adding highlights. Because highlights are established using \colorbox{} and \addfootnote{}, this can cause a number of compilation issues when trying to build the diff files.

Example:
\subsection{Review of\colorbox{teal}{ MSR }\footnote{2h: Reduce acronyms/jargon}Multiphysics Simulations and Results} \label{sec:msr-tools}

This issue can be resolved when the highlight function of the script is modified to avoid highlighting in such special environments.

@osanstrong osanstrong self-assigned this Aug 27, 2024
@osanstrong osanstrong added Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:1-Critical This is the highest priority (i.e. it is blocking other work or facing a deadline). Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Bug Something is wrong or broken. This issue or PR is related to a bug in code. labels Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:1-Critical This is the highest priority (i.e. it is blocking other work or facing a deadline). Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Bug Something is wrong or broken. This issue or PR is related to a bug in code.
Projects
None yet
Development

No branches or pull requests

1 participant