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

LaTeX compliance for formulas and errors in bibliography #8636

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

albert-github
Copy link
Contributor

@albert-github albert-github commented Dec 2, 2024

Correction of incorrect usage of LaTeX in formulas and bibliography altough MatHJax and bibtex.pl doesn't always signal it.

  • Incorrect biblio entry (missing , and })
    • Documentation/doc/biblio/geom.bib
  • &nbsp is not correct LaTeX has to be ~
    • Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
    • Documentation/doc/Documentation/Developer_manual/Chapter_intro.txt
  • Incorrect formula regarding usage of \left and \right (also signaled by MathJax
    • Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
  • DeclareMathOperator is a command that should be in the preamble, alternatively the command \operatorname can be used explicitly (as done here as it is only used once)
    • Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/Kinetic_surface_reconstruction.txt
  • Latex has problems with _ in a text... command so it should be escaped though this gives problems with MathJax hence the extra hook. MathJax reference: https://groups.google.com/g/mathjax-users/c/wSh6-hSIUpQ/m/KmzZhQQGslgJ
    • Documentation/doc/resources/1.10.0/CGAL_mathjax.js
    • Documentation/doc/resources/1.8.13/CGAL_mathjax.js
    • Documentation/doc/resources/1.9.6/CGAL_mathjax.js
    • Weights/include/CGAL/Weights/authalic_weights.h

Correction of incorrect usage of LaTeX  in formulas and bibliography altough MatHJax and bibtex.pl doesn't always signal it.
- Incorrect biblio entry (missing `,` and `}`)
  - Documentation/doc/biblio/geom.bib
- `&nbsp` is not correct LaTex has to be `~`
  - Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
  - Documentation/doc/Documentation/Developer_manual/Chapter_intro.txt
- Incorrect formula regarding usage of `\left` and `\right` (also signaled by MathJax
  - Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
- `DeclareMathOperator` is a command that should be in the preamble, alternatively the command `\operatorname` can be used explicitly (as done here as it is only used once)
  - Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/Kinetic_surface_reconstruction.txt
- Latex has problems with `_` in a `text...` command so it should be escaped though this gives problems with MathJax hence the extra hook.
  MathJax reference: https://groups.google.com/g/mathjax-users/c/wSh6-hSIUpQ/m/KmzZhQQGslgJ
  - Documentation/doc/resources/1.10.0/CGAL_mathjax.js
  - Documentation/doc/resources/1.8.13/CGAL_mathjax.js
  - Documentation/doc/resources/1.9.6/CGAL_mathjax.js
  - Weights/include/CGAL/Weights/authalic_weights.h
@afabri afabri added the Doc bug label Dec 2, 2024
@afabri afabri added this to the 6.1-beta milestone Dec 2, 2024
@afabri
Copy link
Member

afabri commented Dec 2, 2024

I guess it would be trivial to apply that to the 6.0 branch

@sloriot
Copy link
Member

sloriot commented Dec 4, 2024

Successfully tested in CGAL-6.1-Ic-33

@albert-github
Copy link
Contributor Author

albert-github commented Dec 4, 2024

Why no label "Tested" and remove "Under Testing"?

@sloriot sloriot added the Tested label Dec 4, 2024
@sloriot sloriot merged commit 6870528 into CGAL:master Dec 10, 2024
8 checks passed
@sloriot sloriot deleted the feature/bug_formula_biblio branch December 10, 2024 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants