ppgeb_template_latex

PPGEB-UFU template

This repository contains a document template for final coursework, dissertation, and thesis for the Undergraduate and Graduate Programs in Biomedical Engineering at the Federal University of Uberlândia.

🪄 Preview

Cover	Contents	Content example

👉 Click here to view the compiled PDF

🗂 Project structure

./
│   .gitignore                       # This file can be removed
│   main.pdf                         # Final document example 
│   main.tex                         # Main LaTeX file
│   ppgeb.cls                        # Custom document class
│   README.md                        # This file can be removed
│   titlepage.tex
│   tree.txt
│
├───chapters   # Document chapters
│       chapter_conclusion.tex
│       chapter_discussion.tex
│       chapter_introduction.tex
│       chapter_methods.tex
│       chapter_results.tex
│
├───figs              # Directory containing the figures used
│   │   LogoUFU.pdf
│   │
│   └───template      # This folder is intended solely for documents pertaining to the institution's logo, defense minutes, and catalog cards
   
│           AtaDeDefesa.pdf
│           FichaCatalografica.pdf
│           Logo.pdf
│
├───postextual
│       appendix1.tex
│
├───pretextual
│       abstract.tex
│       acknowledgements.tex
│       glossary.tex
│       preamble.tex
│
└───references
        ref.bib

📄 Generating the final document

This LaTeX template can be compiled to PDF either locally on your computer or using Overleaf online.

1. Using Overleaf

1. Upload the repository to Overleaf.
2. Open main.tex.
3. Click Recompile to generate the PDF.
4. The output PDF will appear in the Overleaf preview.

2. Local compilation

To compile the document locally, make sure the following requirements are met:

🪛 Requirements

• LaTeX distribution:
  • Linux/macOS: TeX Live
  • Windows: MiKTeX
• PDF compiler:
  • pdflatex or lualatex
  • Recommended: latexmk for automatic compilation of multiple passes
• LaTeX editor:
  • a LaTeX or code editor, such as TeX MAKER, TeXStudio or VSCodium
• Required LaTeX packages (most of them are included in standard LaTeX distributions):
  • graphicx (for including images)
  • subcaption (for subfigures)
  • amsmath, amssymb (for math symbols)
  • tcolorbox (for boxes and highlights)
  • hyperref (for urls)
  • longtable, tabularx, xltabular (for tables)
  • listings (for source code formatting)
• Bibliography management:
  • a reference manager like Jabref

⚡Useful shortcuts to make your life easier

This template uses the glossaries package to generate glossaries and acronyms. When compiling the document locally, you can configure a custom command to run makeglossaries directly from the editor menu.

• 🔧 How to configure in TeX MAKER
  1. Open TeX MAKER
  2. Go to: Users → User commands → Edit user commands
  3. Add a new command with the following settings:
     • Menu item name: makeglossaries
     • Command: makeglossaries %

In addition, you can configure a shortcut to automatically compile the document using latexmk.

• 🔧 How to configure in TeX MAKER
  1. Open TeX MAKER
  2. Go to: Users → User commands → Edit user commands
  3. Add a new command with the following settings:
     • Menu item name: latexmk
     • Command: latexmk -synctex=1 -interaction=nonstopmode -bibtex -pdf  %.tex | "C:/Program Files/Adobe/Acrobat DC/Acrobat/Acrobat.exe" %.pdf

⚠️ Atention: In this case, you can specify the absolute path to your PDF reader executable (e.g., C:/Program Files/Adobe/Acrobat DC/Acrobat/Acrobat.exe).

This template also uses the minted package, which relies on Pygments, a Python library, to colour source code. Because of this, the LaTeX compiler needs to execute external commands — something that is disabled by default for security reasons.

Step 1: Check if Python and Pygments are installed

Open PowerShell and type:

python --version

If you see something like Python 3.x.x, great. In case you don’t have Python already, you can download it from here.

Now check Pygments:

python -m pygments -V

If you see something like Pygments version 2.x.x, everything is fine. If you get an error such as pygmentize not recognized, install Pygments with:

pip install Pygments

Step 2: Compile with -shell-escape

Since minted needs to call Pygments, which is an external program, you need to allow the LaTeX processor to do so by passing it the -shell-escape option. So you need to call the processor like this

Instead of compiling with

pdflatex main.tex

use

pdflatex -shell-escape main.tex

Or, if you use latexmk (recommended):

latexmk -pdf -shell-escape main.tex

🧬 Installation or Project Download

If you are a Git user, you can clone the project using:

git clone https://github.com/NIATS-UFU/ppgeb_template_latex.git

Alternatively, you can download the project as a ZIP file.

🍰 How to Contribute?

If you would like to contribute, please follow these steps:

1. Fork this repository.
2. Create a new branch for your changes (git checkout -b feature-name).
3. Make your changes and commit them (git commit -m "📝 Describe your changes").
4. Push the branch to your fork (git push origin feature-name).
5. Open a pull request on the main repository.

🤝 Support

Found a bug or have an idea?

• Open an Issue for bug reports.
• Start a Discussion for suggestions or questions.

Your feedback helps improve the project.

📬 Questions?

If you have any questions or need help using this template, feel free to open an issue or contact the repository maintainer.

▲ top