UTBM Internship Report Template in $LaTeX$

This repository serves as a template for internship reports at UTBM. It is built upon the UTBM internship LaTeX version and has been updated, adapted and expanded with multiple functionalities.

Important

This template is free to use, but the covers belongs to UTBM and can only be used with their authorization.

Note

UTBM and all UTBM-related trademarks and logos are trademarks or registered trademarks of the University of Technology of Belfort-Montbéliard in France, other countries, or both.

I. Support

This template can be used in several places:

• Online with Overleaf or GitHub Codespaces
• Locally on Windows/MacOS/Linux

II. Features

UTBM's Covers

You can find all configurable options for the covers with the commands below. If you want more freedom, you can still edit the covers by modifying this file.

UTBM-Internship-Report/main.tex

Lines 40 to 56 in 70ee781

	%----------------------------------------
	% UTBM covers configuration
	%----------------------------------------
	% \setutbmfrontillustration{}
	% \setutbmtitle{}
	% \setutbmsubtitle{}
	% \setutbmstudent{}
	% \setutbmstudentdepartment{}
	% \setutbmstudentpathway{}
	% \setutbmcompany{}
	% \setutbmcompanyaddress{}
	% \setutbmcompanywebsite{}
	% \setutbmcompanytutor{}
	% \setutbmschooltutor{}
	% \setutbmabstract{}

You can also modify their colors using these variables:

UTBM-Internship-Report/libs/utbmcovers.sty

Lines 34 to 51 in 70ee781

	%----------------------------------------
	% Colors definitions
	%----------------------------------------
	\definecolor{utbm_cover_university_background_color}{RGB}{41,39,42}
	\definecolor{utbm_cover_university_text_color}{RGB}{255,255,255}
	\definecolor{utbm_cover_scarf_background_color}{RGB}{27,94,135}
	\definecolor{utbm_cover_scarf_text_color}{RGB}{255,255,255}
	\definecolor{utbm_cover_subtitle_background_color}{RGB}{79,78,85}
	\definecolor{utbm_cover_subtitle_text_color}{RGB}{255,255,255}
	\definecolor{utbm_cover_main_background_color}{RGB}{98,184,143}
	\definecolor{utbm_cover_main_text_color}{RGB}{255,255,255}
	\definecolor{white}{RGB}{255,255,255}

Finally you can call both covers using:

\makeutbmfrontcover{} % Front cover
\makeutbmbackcover{}  % & Back cover

Covers support English and French languages, you can change the language using the babel package:

\usepackage[english]{babel} % English
\usepackage[french]{babel}  % French

---

III. Usage

Online

Overleaf

1. There are two ways to import this template on Overleaf:

   • You can either use the Import from GitHub button and paste the link of this repository. (This method requires a paid plan)
   • Alternatively, you can download the repository as a zip file and upload it on Overleaf. (This method is free but you don't have git anymore)

2. The last step is to change the compiler from pdfLaTeX to XeLaTeX. You can do this by clicking on the Menu button and finding it in the Settings category.

GitHub Codespaces

1. Use this repository as a template:

   • by clicking on the Use this template button (see how here)
   • by clicking here.

2. Once you have your own repository, open it as a GitHub Codespaces and wait for it to fully build.

3. Install the recommended VSCode extension to be able to compile your files with LaTeX Workshop

4. Run the following command to get full git access:

     git config --global --add safe.directory /workspace

Locally

Note

• You will need a $LaTeX$ distribution to compile this project locally.
• You will need an IDE to edit and compile your $LaTeX$ files.
• You may use this repository as a template by clicking on the Use this template button (see how here) or using this link.

Part A: LaTeX distribution

MiKTeX

Website — Download

Easy to install but does not ship with Perl, which the latexmk package requires.

1. Install MiKTeX using the above link. Then, you have the option to upgrade your installation to a standard TeX system by clicking the Upgrade button. Please be aware that this initiates a ~200MB download. Alternatively, you can enable the auto-install feature and let MiKTeX install missing packages on-the-fly. You can find this option in the Settings tab.

On Windows

2. Install Perl using Strawberry Perl, available here. Once installed, verify that Perl is available by opening a new command prompt and typing perl -v. If installed correctly, you should see the version of Perl that you installed.

3. Verify that both Perl and MiKTeX are in your PATH and restart any open command prompts.

4. You should now be able to compile your LaTeX files using MiKTeX.

On MacOS

2. Install Perl using Homebrew, available here.

   brew install perl
   

   Once installed, verify that Perl is available by opening a new terminal and typing perl -v. If installed correctly, you should see the version of Perl that you installed.

3. Add ~/bin to your PATH by including the following line in your ~/.zshrc file:

   export PATH="/Users/<username>/bin:$PATH"
   

4. You should now be able to compile your $LaTeX$ files using MiKTeX.

Warning

In 3rd step we use the full path instead of ~/bin or $HOME/bin as the ~ and $HOME variables do not work in combination with the VS Code latex-workshop extension.

TexLive

Website

For more in-depth information, take a look at the documentation.

TeX is a really popular distribution. Despite the installation process being quite lengthy, it enables the direct use and compilation of a project using this repository in VSCode, as explained later.

On Windows

Follow the link, download install-tl-windows.exe, and install the distribution just like any other program.

On MacOS (MacTeX)

Note

The name is different, but it is developed by the same team of programmers. It has not been tested whether the operating conditions are identical to those on Windows. Let us know if you are in this situation.

An installation and usage guide is available here. Do not hesitate to make a PR if you have any information to add.

---

Part B: IDE

Visual Studio Code

Website

This template requires the use of the LaTeX Workshop extension to compile the LaTeX files directly within VS Code.

While not mandatory, the following extensions are recommended for some Quality of Life improvements:

• 🔸 LaTeX Utilities - Useful extension to extend the capabilities of LaTeX Workshop.
• 🪄 LaTeX Formatter - Enhance the code base for a more user-friendly experience.
• 🔦 LaTeX language support - This extension adds syntax highlighting for LaTeX files.
• 📗 Code Spell Checker - Don't let typos slip through the cracks.

To compile the report, you can use the Ctrl + Alt + B shortcut or the LaTeX Workshop: Build LaTeX project command inside Visual Studio Code.

You can open and use this project by opening the folder in the source control menu (on the left-hand side of the interface) and using this link: https://github.com/Juknum/UTBM-Internship-Report.git.

Note

More information on the LaTeX Workshop extension can be found here.

---

If you want to contribute to this project, feel free to make a PR 🤍