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

Use LaTeX best practices and packages #681

Open
carlostome opened this issue Feb 7, 2025 · 1 comment
Open

Use LaTeX best practices and packages #681

carlostome opened this issue Feb 7, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation latex this is latex specific

Comments

@carlostome
Copy link
Contributor

carlostome commented Feb 7, 2025

I'm opening this issue to collect a bunch of do/don't for latex which we should agree to follow in the document (if we stick to latex (see #680).

  • Use:

    • cleveref for references. Provides a family of commands \cref which typeset the type of thing being referenced.
    • biblatex for citations. Provides new commands for citation depending on how the cited reference is being used (as subject, object, withing parenthesis etc). It can be setup to use biber as a backend, which among others supports bib files that use UTF-8.
    • xparse for a reimplemented interface to define commands (this package is now part of latex itself)
  • Avoid:

  • TBD

    • Agree on a naming convention for references.
    • Find a proper way of splitting big figures across pages.
@carlostome carlostome added documentation Improvements or additions to documentation latex this is latex specific labels Feb 10, 2025
@WhatisRT
Copy link
Collaborator

Can you say a few words about what problems these packages solve? I'm all for improving the LaTeX code, but I like knowing what is actually being improved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation latex this is latex specific
Projects
None yet
Development

No branches or pull requests

2 participants