Improve latex typography #231
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This option was never used.
github-actions
bot
added
area:Introduction
hjmjohnson
force-pushed
the
fix-latex2e-compliance
branch
from
5d45482 to
e37c614
Compare
The 3 times running of latex has been done with cmake logic since 2015.
The hyperref option should be correctly inferred in all modern versions of latex. This avoids problems when building the document with other tools (like pandoc, pdflatex, or latexmk).
hjmjohnson
force-pushed
the
fix-latex2e-compliance
branch
from
e37c614 to
17b932e
Compare
thewtex
previously approved these changes
Jan 16, 2026
hjmjohnson
force-pushed
the
fix-latex2e-compliance
branch
from
17b932e to
b0ea96d
Compare
dzenanz
reviewed
Jan 16, 2026
Member
dzenanz
left a comment
dzenanz
left a comment
There was a problem hiding this comment.
Mostly looks good. Cursory review identified some questions.
In modern LaTeX, you should not use the old two-letter command \bf.
Instead, you should use the recommended \textbf{...} command or the
\bfseries declaration for producing bold text.
Search for and replace obsolete font commands in all .tex
- Replace `{\bf ...}` with `\textbf{...}`
- Replace `{\it ...}` with `\textit{...}`
- Replace `{\tt ...}` with `\texttt{...}`
- Replace `{\rm ...}` with `\textrm{...}`
- Replace `{\sc ...}` with `\textsc{...}`
- Replace `{\sf ...}` with `\textsf{...}`
- Replace `{\sl ...}` with `\textsl{...}`
- Replace `{\cal ...}` with `\mathcal{...}`
- Replace `{\em ...}` with `\emph{...}`
Search for and replace other obsolete commands:
- Replace `\over` with `\frac{...}{...}` or `\overline{...}`:
Prevent LaTeX line breaks that may cause a \label or \index to be referenced in the wrong place for page references. Delete this space to maintain correct pagereferences. Found with `chktex` latex linting tool
Ensures proper layout and prevent misaligned page references
cite, ref, pageref, Figure, Table should have the reference information adjacent to the preceeding text for clarity.
A linter test suggestion by chktex
Replace the literal double-quote character in LaTeX. It is for the rare cases where you actually want the ASCII " glyph, not typographic quotes. chktex warns when " character is used without explicit request for the type of quotes needed.
…` tables Improve the visual representation of tables following recommendations provided by chktex linting and online suggestions.
User Regex: 1:Capitalize before references.
For identifying and addressing common formatting issues
This ensures compatibility by requiring ImageMagick version 6 or greater and the `convert` component in relevant CMake files. Updates improve dependency clarity, preventing potential issues with older versions or missing components. ImageMagick version 7 was released as a production version in May 2016. ImageMagick version 7 deprecates the 'convert' tool which will be removed in future version. Support both version 6 and 7 with cmake syntax introduced in cmake version 3.9.
hjmjohnson
force-pushed
the
fix-latex2e-compliance
branch
from
b0ea96d to
6feafa5
Compare
Member
Author
|
@dzenanz I think I addressed all the issues you mentioned. |
Member
Author
|
@thewtex I had a silly syntax error that needed fixing. This is now done. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Review the Insight Software guide and run the chktex linting tool
to identify places where the software guide can be made more robust.