UTBM — Internship Report Template

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

Table of Contents

I. Support II. Usage & Features UTBM's Covers III. Usage Online Locally Part A: LaTeX distribution Part B: IDE

I. Support

This template can be used in several places:

• Online with Overleaf
• Locally on Windows/MacOS/Linux

---

II. Features

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.

UTBM's Covers

You can find all configurable options for UTBM covers in the code below. If you're unsatisfied, you still have the option to edit the covers using this file.

UTBM-Internship-Report/main.tex

Lines 32 to 55 in 108d23d

	%----------------------------------------
	% UTBM covers configuration
	%----------------------------------------
	\setutbmfrontillustration{assets/images/utbm_default_illustration}
	\setutbmtitle{REPORT TITLE}
	\setutbmsubtitle{Internship Report ST40 - P2023}
	\setutbmstudent{JACQUES Pierre-Paul}
	\setutbmstudentdepartment{Computer Science Depertment}
	\setutbmstudentpathway{IA - Artificial Intelligence}
	\setutbmcompany{Company DEMO-Controlers}
	\setutbmcompanyaddress{8 rue de la Fierté\\75 013 Paris}
	\setutbmcompanywebsite{www.democontrollers.com}
	\setutbmcompanylogo{assets/images/default_company}
	\setutbmcompanytutor{COMPANY Tutor}
	\setutbmschooltutor{SCHOOL Tutor}
	\setutbmkeywords{
	[N°X – Y] Keyword 1,
	[N°X – Y] Keyword 2,
	[N°X – Y] Keyword 3,
	[N°X – Y] Keyword 4,
	}
	\setutbmabstract{ \lipsum[1-2] }

You can also modify their colors using these variables:

UTBM-Internship-Report/libs/utbmcovers.sty

Lines 36 to 55 in 108d23d

	%----------------------------------------
	% Colors definitions
	%----------------------------------------
	\definecolor{utbm_cover_background}{RGB}{255,255,255}
	\definecolor{utbm_cover_univname}{RGB}{0,0,0}
	\definecolor{utbm_cover_univname_text}{RGB}{255,255,255}
	\definecolor{utbm_cover_title}{RGB}{145,91,168}
	\definecolor{utbm_cover_title_text}{RGB}{255,255,255}
	\definecolor{utbm_cover_subtitle}{RGB}{73,73,73}
	\definecolor{utbm_cover_subtitle_text}{RGB}{255,255,255}
	\definecolor{utbm_cover_main}{RGB}{255,244,95}
	\definecolor{utbm_cover_main_text}{RGB}{0,0,0}
	\definecolor{utbm_cover_main_no_background}{RGB}{0,0,0}
	\definecolor{utbm_cover_main_shadow_text}{RGB}{128,128,128}

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

There are multiple ways to use this template; you can either use it online or locally:

Online

Overleaf

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) 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.

Any other online LaTeX editors to suggest?

Locally

Clone this repository using the following command:

git clone 'https://github.com/Juknum/UTBM-Internship-Report/tree/main'

Note

You may also want to use this repository as a template. You can do this by clicking on the Use this template button or by clicking here.

Part A: LaTeX distribution

You will need a LaTeX distribution to compile this project locally. Here is a list of tested and working distributions for this project:

MiKTeX

Website — Download Easy to install but does not ship with Perl, which the latexmk package requires. 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 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. Verify that both Perl and MiKTeX are in your PATH and restart any open command prompts. You should now be able to compile your $LaTeX$ files using MiKTeX. On MacOS 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. Add ~/bin to your PATH by including the following line in your ~/.zshrc file: export PATH="/Users/<username>/bin:$PATH" [!WARNING] Here, we use the full path instead of ~/bin or $HOME/bin because the ~ and $HOME variables do not work in combination with the VS Code latex-workshop extension. You should now be able to compile your $LaTeX$ files using MiKTeX.

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) Warning 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.

Any other LaTeX distribution to suggest?

Part B: IDE

After installing a LaTeX distribution, you will need an IDE to edit and compile your $LaTeX$ files. Here is a list of tested and working IDEs for this project:

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. [!NOTE] More information on the LaTeX Workshop extension can be found here. 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.

Any other IDE to suggest?

---

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